¶ Overview
The rendering pipeline defines how your content is rendered into it's final readable form.
Rendering modules are attached to a core language module. Depending on the editor used, content will go through several core rendering modules CRM. For example, using the Markdown editor will result in the content being transformed through the Markdown CRM, then by the HTML CRM modules.
Each core rendering module can consist of multiple extension rendering modules ERM. These modules extend the capabilities of the core rendering module.
Each module can be enabled / disabled individually and configured in the Administration Area under the Rendering sidebar menu.
¶ Markdown
Converts Markdown content into HTML.
- Allow HTML: Enable HTML tabs in content.
- Automatically convert links: Links will automatically be converted into clickable links.
- Automatically convert line breaks: Add linebreaks within paragraphs.
- Typographer: Enable some language-neutral replacement + quotes beautification.
- Quotes style: When typographer is enabled. Double + single quotes replacement pairs. e.g. «»„“ for Russian, „“‚‘ for German, etc.
¶ Abbreviations
Transform abbreviation words into <abbr> tags for an expanding definition.
*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
The HTML specification
is maintained by the W3C.
will result in
<p>The <abbr title="Hyper Text Markup Language">HTML</abbr> specification
is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.</p>
This module doesn't have any configurable parameters.
¶ Emoji
Convert tags into emojis.
:apple: will produce 
This module doesn't have any configurable parameters.
¶ Expand Tabs
Automatically convert tabs into spaces for consistent indentation spacing in HTML.
- Tab Width: The number of spaces to use when converting from tabs.
¶ Footnotes
Generates footnote definitions.
This module doesn't have any configurable parameters.
¶ Image Size
Add image dimensions to img tags.
will result in
<p><img src="image.png" alt="test" width="100" height="200"></p>
This module doesn't have any configurable parameters.
¶ Katex
Generate visual Math / Chemical expressions from TeX expressions, using the KaTeX engine.
This module is incompatible with the Mathjax module. Only one of them should be enabled at once.
- Inline TeX: Process inline TeX expressions surrounded by $ symbols.
- TeX Blocks: Process TeX blocks enclosed by $$ symbols.
¶ Kroki
Generate diagrams from various textual descriptions.
The diagram type must be put on the second line, in lowercase.
See https://kroki.io/#support for the full list of supported diagram types.
This module is only available from version 2.4 and up.
```kroki
mermaid
graph TD
A[ Anyone ] -->|Can help | B( Go to github.com/yuzutech/kroki )
B --> C{ How to contribute? }
C --> D[ Reporting bugs ]
C --> E[ Sharing ideas ]
C --> F[ Advocating ]
```
- Kroki Server: Kroki server used for image generation
- Open Marker: String to use as opening delimiter. Diagram type must be put in the next line in lowercase.
- Close Marker: String to use as closing delimiter
¶ Mathjax
Generate visual Math / Chemical expressions from TeX expressions, using the Mathjax engine.
This module is incompatible with the Katex module. Only one of them should be enabled at once.
This module is only available from version 2.4 and up.
- Inline TeX: Process inline TeX expressions surrounded by $ symbols.
- TeX Blocks: Process TeX blocks enclosed by $$ symbols.
¶ PlantUML
Generate diagrams from PlantUML description.
- Kroki Server: PlantUML server used for image generation.
- Open Marker: String to use as opening delimiter.
- Close Marker: String to use as closing delimiter.
- Image Format: Format to use for rendered PlantUML images
¶ Subscript/Superscript
Transform text into subscript and superscript tags.
H~2~0
Exp^10^
will result in
H<sub>2</sub>O
Exp<sup>10</sup>
- Subscript: Enable subscript tags.
- Superscript: Enable supercript tags
¶ Task Lists
Convert square brackets list into HTML checkboxes.
- [ ] Item 1
- [ ] Item 2
- [x] Item 3
will result in
- Item 1
- Item 2
- Item 3
This module doesn't have any configurable parameters.
¶ HTML
Process HTML through extension modules.
- Treat relative links as root absolute: For example, a link to foo/bar on page xyz will render as /foo/bar instead of /xyz/foo/bar.
- Open external links in a new tab: External links will have a _blank target attribute added automatically.
- Protect against XSS when opening _blank target links: External links with _blank attribute will have an additional rel attribute.
¶ Asciinema
Coming soon
¶ Blockquotes
Parse blockquotes box styling.
This module doesn't have any configurable parameters.
¶ Code Highlighting Post-Processor
Automatically detect programming code syntax and apply the correct code coloring classes.
This module doesn't have any configurable parameters.
¶ Media Players
Coming soon
¶ Mermaid
Transform Mermaid code blocks into Mermaid diagrams.
This module is only available from version 2.3 and up.
This module doesn't have any configurable parameters.
¶ Security
Filter and strip potentially dangerous content.
- Sanitize HTML: Sanitize HTML from unsafe attributes and tags that could lead to XSS attacks.
- Allow iframes: iframes will not be stripped if enabled. (Not recommended)
¶ Tabsets
Create tabs to organize content.
This module is only available from version 2.4 and up.
This module doesn't have any configurable parameters.
¶ Twemoji
Convert emojis into their Twemoji equivalent (Twitter emoji design).
This module doesn't have any configurable parameters.