How to use Markdown
Here is a cheatsheet of Markdown to help you format.
Basic inline formatting with Markdown
- Bold – Type
**text**
or__text__
, - Italic – Type
*text*
or_text_
, Code
– Type`text`
,Strikethrough– Type~~text~~
.
Block formatting with Markdown
- Headings – Start a line with
#
or##
or###
followed by a space to create a heading 1, heading 2 or heading 3 (up to heading 6 if {@link module:heading/heading~​HeadingConfig#options} defines more headings). - Bulleted list – Start a line with
*
or-
followed by a space. - Numbered list – Start a line with
1.
or1)
followed by a space. - To-do list – Start a line with
[ ]
followed by a space. - Block quote – Start a line with
>
followed by a space. - Code block – Start a line with
```
. - Horizontal line – Start a line with
---
.
Keyboard Shortcuts
If you like to mix and match using Markdown with accessible keyboard shortcuts, then here is a cheatsheet of CKEditor 5 keyboard shortcuts.
Action | PC | Mac |
---|---|---|
Copy | Ctrl + C | ⌘ + C |
Paste | Ctrl + V | ⌘ + V |
Paste plain text and inherit target formatting | Ctrl + Shift + V | ⌘ + Shift + V |
Undo | Ctrl + Z | ⌘ + Z |
Redo | Ctrl + Y Ctrl + Shift + Z | ⌘ + Y ⌘ + Shift + Z |
Select all | Ctrl + A | ⌘ + A |
Bold | Ctrl + B | ⌘ + B |
Italic | Ctrl + I | ⌘ + I |
Link | Ctrl + K | ⌘ +K |
Insert a hard break (e.g. a new paragraph) | Enter | |
Insert a soft break (i.e. a<br> ) | Shift + Enter | |
Nest the current list item (when in a list) | Tab | |
Move out of link or inline style | ←← / →→ | |
When a widget is selected (for example: image, table, horizontal line, etc.) | ||
Insert a new paragraph directly after a widget | Enter | |
Insert a new paragraph directly before a widget | Shift + Enter | |
Display the caret to allow typing directly before a widget | ↑ / ← | |
Display the caret to allow typing directly after a widget | ↓ / → | |
In a table cell | ||
Move the selection to the next cell | Tab | |
Move the selection to the previous cell | Shift + Tab | |
Insert a new table row (when in the last cell of a table) | Tab | |
Navigate through the table | ↑ / → / ↓ / ← |