Markdown Editor

Learn how to change the default editor and use Markdown for formatting reference and component descriptions in Ardoq.

Kristine Marhilevica avatar
Written by Kristine Marhilevica
Updated over a week ago

Markdown Editor

The markdown editor allows you to use markdown for formatting reference and component descriptions.

When editing a description, the default editor is Rich Text; to switch to Markdown, click the “Markdown” link above the editor.

Markdown Syntax

The markdown editor syntax is based on Showdown.

We’ve also added support for tables and syntax highlighting of code blocks.

You can surround code with 3 “backtick” characters to format it:

javascript function(){ alert('my code'); }

Ardoq 3 backtick
Did this answer your question?