Child pages
  • PegDown Formatter Plugin
Skip to end of metadata
Go to start of metadata

Plugin Information

View PegDown Formatter on the plugin site for more information.

Features
Compatibility
Install
Configure
Change log

Features

  • Use PegDown to format Markdown syntax in descriptions in Jenkins, eg, view, job, build, the system message, etc.
  • Disable HTML to prevent XSS
  • Enable/ disable all of the PegDown extensions

Compatibility

This plugin is compatible with any version of Jenkins (1.396+)

Install

This plugin can be installed from the Plugin Manager (Manage Jenkins > Manage Plugins) under "User Interface".

To install manually, download the latest plugin from http://mirrors.jenkins-ci.org/plugins/pegdown-formatter/ and use the Upload Plugin option in the Advanced tab of the Plugin Manager.

Configure

In Manage Jenkins -> Configure Global Security, select "Enable security".
Next to Markup Formatter, select "PegDown" from the drop down list.

To ensure that Jenkins does not lose configuration when you return to the Configure System page, make sure that you select one of the Security Realms.
To leave Jenkins "open" select "Jenkins's own user database" and "Anyone can do anything" under Authorization.

SUPPRESS_ALL_HTML

Select this option to strip HTML from the description fields

Advanced options

Clicking on the Advanced button will reveal the following extensions which can be enabled/disabled individually.

ABBREVIATIONS
DEFINITIONS
FENCED_CODE_BLOCKS
HARDWRAPS
SMARTYPANTS
TABLES

See the PegDown GitHub page for details of these extensions.

Change log

1.3 (09/04/2012)

  • Enable the plugin to work with Jenkins 1.455 onwards JENKINS-13111

1.2 (04/08/2011)

  • HTML syntax highlighting disabled when SUPPRESS_ALL_HTML is selected (in Jenkins 1.425+)

1.1 (26/07/2011)

  • Added the ABBREVIATIONS extension option

1.0 (26/07/2011)

  • Initial release

Questions, Comments, Bugs and Feature Requests

Please post questions or comments about this plugin to the Jenkins User mailing list.
To report a bug or request an enhancement to this plugin please create a ticket in JIRA.