User Documentation

Markdown Editor

If you prefer to write in Markdown, the editor in BookStack can be changed at an instance level to use a Markdown editor instead of the default WYSIWYG editor. The option to use Markdown is currently not a user setting but a global instance setting due to formatting differences between the two editors.

Note that shifting to the Markdown editor from the WYSIWYG editor may cause unintended side effects to existing content. This is due to the differences in the way the content is stored in the database.

Switching to the Markdown Editor

To change the editor to Markdown follow the steps below. You’ll need to have the “Manage app settings” role permission to be able to follow these steps:

  1. Within your BookStack instance, find and click on Settings in the navbar.
  2. Scroll down to the Customization section.
  3. Find the Page Editor setting and select Markdown from the dropdown menu.
  4. Save settings.

Editor Shortcuts

The following shortcuts are available in the Markdown Editor:

Shortcut (Windows & Linux/Mac) Description
Ctrl+S / Cmd+S Save Draft
Ctrl+Enter / Cmd+Enter Save Page & Continue
Ctrl+1 / Cmd+1
Ctrl+2 / Cmd+2
Ctrl+3 / Cmd+3
Ctrl+4 / Cmd+4
Header Large (h2)
Header Medium (h3)
Header Small (h4)
Header Tiny (h5)
Ctrl+5 / Cmd+5
Ctrl+D / Cmd+D
Normal Paragraph
Ctrl+6 / Cmd+6
Ctrl+Q / Cmd+Q
Ctrl+7 / Cmd+7
Ctrl+E / Cmd+E
Code Block
Ctrl+8 / Cmd+8
Ctrl+Shift+E / Cmd+Shift+E
Inline Code
Ctrl+9 / Cmd+9 Callout (Info)
Ctrl+K / Cmd+K Insert Link
Ctrl+Shift+K / Cmd+Shift+K Show link selector
Ctrl+Shift+I / Cmd+Shift+I Insert Image