# markdown-formatter-plugin

**Repository Path**: mirrors_jenkinsci/markdown-formatter-plugin

## Basic Information

- **Project Name**: markdown-formatter-plugin
- **Description**: Allow markdown in Jenkins
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-03
- **Last Updated**: 2026-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown formatter

Markdown Formatter allows plain text to be converted into HTML in Jenkins.
The formatter uses [CommonMark](https://commonmark.org/).

## Getting started

In Manage Jenkins -> Security -> Markup Formatter select "Markdown Formatter" from the drop-down list.

Markdown syntax highlighting is enabled by default while editing the Markdown text in the Jenkins pages.
A configuration checkbox is available in the "Security" page to disable syntax highlighting while editing Markdown text in Jenkins.

## Configuration as code

The [configuration as code plugin](https://plugins.jenkins.io/configuration-as-code/) can define the markup formatter and its configuration.

```yaml
jenkins:
  markupFormatter:
    markdownFormatter:
      disableSyntaxHighlighting: false
```

## Contributing

Refer to our [contribution guidelines](https://github.com/jenkinsci/.github/blob/master/CONTRIBUTING.md)

## LICENSE

Licensed under MIT, see [LICENSE](LICENSE.md)