kuenzign / WikiMarkdown

MediaWiki extension that allows for markdown syntax to be used on wiki pages

About

This is a MediaWiki extension that allows for markdown syntax to be used on wiki pages. More information can be found on the extension page.

Requirements

This version of the extension has been tested with Parsedown 1.7.4, Parsedown Extra 0.8.1, and MediaWiki 1.35.

Installation

Add this line to your LocalSettings.php:

wfLoadExtension( 'WikiMarkdown' );

This extension requires Parsedown to be installed and optionally Parsedown Extra and Parsedown Extended. Either install them manually, or use Composer by adding the line "extensions/WikiMarkdown/composer.json" to the "composer.local.json" file in the root directory of your wiki, e.g.

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/WikiMarkdown/composer.json"
			]
		}
	}
}

Then run composer update in the root directory of your wiki.

Usage

On wiki pages, you can now use <markdown> elements:

<markdown>
## Emphasis

**This is bold text**

__This is bold text__

*This is italic text*

_This is italic text_

~~Strikethrough~~
</markdown>

Parameters

• inline: Indicates that inline-style markdown should be used instead of block-style.

Configuration

• $wgAllowMarkdownExtra (optional): Set to true in order to specify that Parsedown Extra should be used.
• $wgAllowMarkdownExtended (optional): Set to true in order to specify that Parsedown Extended should be used.
• $wgParsedownExtendedParameters (optional): Allows for specifying the options that are passed to Parsedown Extended. See the documentation for which options you want to enable or disable.

Other Features

• This extension also functions as a content handler for wiki pages ending in .md. For these pages, the entire page will be interpreted as markdown and markdown syntax highlighting will be used in the editor if you have the CodeEditor extension installed.
• When specifying code blocks in markdown, this extension will automatically apply the SyntaxHighlight extension if it is installed. All languages supported by the SyntaxHighlight extension will work.
• When using Parsedown Extended, this extension will automatically apply the Math extension if it is installed to any math blocks by default. This can be turned off by either not using Parsedown Extended, or modifying $wgParsedownExtendedParameters. The following syntaxes are valid: \[ ... \]/$$ ... $$ (for block mode) and \( ... \)/$ ... $ (for inline mode)
• When using the VisualEditor extension with the CodeEditor extension, markdown blocks will be editable using a markdown editor.

Credits

• This extension was inspired by the Markdown Content Handler by Daniel Kinzler and the Markdown Extension by Blake Harley.
• Parts of this code are based on the SyntaxHighlight and Scribunto extensions.