Skip to content

Commit

Permalink
Include config as code example in documentation
Browse files Browse the repository at this point in the history
One more place to help users as they configure the plugin.
  • Loading branch information
MarkEWaite committed Jun 28, 2024
1 parent 5c4f1bf commit 7057261
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,21 @@ The formatter uses [CommonMark](https://commonmark.org/).

## Getting started

In Manage Jenkins -> Security -> Markup Formatter
select "Markdown Formatter" from the drop down list.
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
Expand Down

0 comments on commit 7057261

Please sign in to comment.