BookStack Code Mirror - website/blob - content/docs/user/markdown-editor.md

 1 +++
 2 title = "Markdown Editor"
 3 description = "Details on using the markdown editor in BookStack"
 4 date = "2017-07-28"
 5 type = "user-doc"
 6 +++
 7
 8 If you prefer to write in Markdown, the editor in BookStack can be changed at an instance level
 9 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.
 10
 11 > 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.
 12
 13
 14 ### Change to Markdown Editor
 15 To change the editor to markdown follow the steps below:
 16 1. In your running BookStack on the navbar click on **Settings**
 17 1. Scroll down to the **Customization** section
 18 1. On **Page Editor** select `Markdown` from the dropdown menu
 19 1. Save settings
 20
 21
 22 ### Editor Shortcuts
 23
 24 The following shortcuts are available in the Markdown Editor:
 25
 26 <table>
 27   <thead>
 28     <tr>
 29       <th>Shortcut (Windows &amp; Linux/Mac)</th>
 30       <th>Description</th>
 31     </tr>
 32   </thead>
 33   <tbody>
 34     <tr>
 35       <td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
 36       <td>Save Draft</td>
 37     </tr>
 38     <tr>
 39       <td><code>Ctrl+Enter</code> / <code>Cmd+Enter</code></td>
 40       <td>Save Page &amp; Continue</td>
 41     </tr>
 42     <tr>
 43       <td>
 44         <code>Ctrl+1</code> / <code>Cmd+1</code> <br>
 45         <code>Ctrl+2</code> / <code>Cmd+2</code> <br>
 46         <code>Ctrl+3</code> / <code>Cmd+3</code> <br>
 47         <code>Ctrl+4</code> / <code>Cmd+4</code>
 48       </td>
 49       <td>
 50         Header Large (h2)<br>
 51         Header Medium (h3)<br>
 52         Header Small (h4)<br>
 53         Header Tiny (h5)
 54       </td>
 55     </tr>
 56     <tr>
 57       <td><code>Ctrl+5</code> / <code>Cmd+5</code><br><code>Ctrl+D</code> / <code>Cmd+D</code></td>
 58       <td>Normal Paragraph</td>
 59     </tr>
 60     <tr>
 61       <td><code>Ctrl+6</code> / <code>Cmd+6</code><br><code>Ctrl+Q</code> / <code>Cmd+Q</code></td>
 62       <td>Blockquote</td>
 63     </tr>
 64     <tr>
 65       <td><code>Ctrl+7</code> / <code>Cmd+7</code><br><code>Ctrl+E</code> / <code>Cmd+E</code></td>
 66       <td>Code Block</td>
 67     </tr>
 68     <tr>
 69       <td><code>Ctrl+8</code> / <code>Cmd+8</code><br><code>Ctrl+Shift+E</code> / <code>Cmd+Shift+E</code></td>
 70       <td>Inline Code</td>
 71     </tr>
 72     <tr>
 73       <td><code>Ctrl+9</code> / <code>Cmd+9</code></td>
 74       <td>Callout (Info)</td>
 75     </tr>
 76     <tr>
 77       <td><code>Ctrl+K</code> / <code>Cmd+K</code></td>
 78       <td>Insert Link</td>
 79     </tr>
 80     <tr>
 81       <td><code>Ctrl+Shift+K</code> / <code>Cmd+Shift+K</code></td>
 82       <td>Show link selector</td>
 83     </tr>
 84     <tr>
 85       <td><code>Ctrl+Shift+I</code> / <code>Cmd+Shift+I</code></td>
 86       <td>Insert Image</td>
 87     </tr>
 88   </tbody>
 89 </table>