Install the Markdown Syntax
Last modified by Vincent Massol on 2026/09/28 14:37
Steps
Install the CommonMark Markdown 1.2 syntax on the farm and enable it, so that users can write pages in Markdown.
- Go to "Administration > Extensions", search for Markdown and click "Install on farm" on the "CommonMark Markdown Syntax 1.2" result, then confirm the installation.
- Go to "Administration > Editing > Syntaxes", clear the "CommonMark Markdown 1.2" checkbox in "Disabled Syntaxes" and click "Save".
- Check the result: when editing a page in the wiki editor, the "Page syntax" field now offers "CommonMark Markdown 1.2".
FAQ
Why can't I install it on a single wiki?
The syntax only works when installed on the farm: the WYSIWYG editor converts the content it saves without knowing the current wiki, so it doesn't find a syntax installed on a single wiki (XWIKI-13438). Once installed on the farm, the syntax can be enabled in the Syntaxes administration of each wiki.
How do I install GitHub-Flavored Markdown?
Follow the same steps with the "GitHub-Flavored CommonMark Syntax 1.0" extension and enable "GitHub-Flavored CommonMark 1.0". It installs CommonMark Markdown Syntax 1.2 as a dependency. See GitHub-Flavored Markdown.
How do I make Markdown the default syntax of new pages?
In "Administration > Editing > Syntaxes", select "CommonMark Markdown 1.2" in "Default page syntax" and click "Save".
