Table of contents

HotDocs: Markdown

DANGER

HotDocs evaluates Ruby code on your server when rendering. Only use it for trusted markdown content.

INFO

Markdown support is currently under development. You can chime in on this GitHub discussion to share wishes and feedback.

HotDocs supports templates ending in .mderb: you can mix markdown and erb in the same template.

Behind the curtains, .mderb templates are compiled first as .erb and second as .md with kramdown & kramdown-parser-gfm.

Syntax highlight

HotDocs highlights code blocks with rouge.

You can customize the css styles by editing rouge.css or by replacing it with any Pygments-compatible theme (just wrap it in .article {}).

Alerts

On top of the markdown syntax, HotDocs supports alerts as follows (icons from Heroicons):

> [!INFO]
> This is an info.

> [!TIP]
> This is a tip.

> [!WARNING]
> This is a warning.

> [!DANGER]
> This is a danger.
INFO

This is an info.

TIP

This is a tip.

WARNING

This is a warning.

DANGER

This is a danger.

Edit this page

Built with Rails & HotDocs