Skip to content

Markdown Editor Usage

Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

Wikipedia Definition

Kraken's Markdown editor is automatically activated for files with the .md or .markdown extension. It allows you to switch from viewing to edition modes.

Markdown Editor View

In View mode, the resulting HTML is displayed.

Click on the Edit button at the top right corner of the editor to switch to the edition mode.

Markdown Editor Edit

In Edit mode, the raw text content is displayed and can bu modified.

Click on the View button at the top right corner of the editor to switch back to the viewing mode.

Tip

You can embed images served by the kraken-static Docker container. This container contains an NGinx server that serves all files under the /api/static path.

For example, display an image named kraken.svg placed in the root directory with the syntax ![Logo](/api/static/kraken.svg "Logo").