Skip to main content
All CollectionsDocs
Markdown Formatting
Markdown Formatting

Customize your notes with familiar markdown shortcuts

Richard Makara avatar
Written by Richard Makara
Updated over 2 months ago

reconfigured supports familiar markdown shortcuts powered by the Tiptap editor, allowing you to format text just like in any other tool. Below is a guide to using markdown.

1. Headings

To create headings, start a new line and use the corresponding number of # symbols followed by a space:

# Heading 1 
## Heading 2 
### Heading 3

Results in:

Heading 1

Heading 2

Heading 3

2. Text Styling

  • Bold: **bold text** → bold text

  • Italic: *italic text* → italic text

  • Strikethrough: ~~strikethrough~~ → strikethrough

NOTE: Remember to close the text with equivalent symbols

Alternatively, you can use keyboard shortcuts:

  • Bold: Highlight the text and press CMD+B (Mac) / CTRL+B (Windows)

  • Italic: Highlight the text and press CMD+I (Mac) / CTRL+I (Windows)

  • Strikethrough: Highlight the text and press CMD+Shift+X (Mac) / CTRL+Shift+X (Windows)

3. Lists

Unordered List

- Item 1 
- Item 2 
- Item 3

Results in:

  • Item 1

  • Item 2

  • Item 3

Ordered List

1. First item 
2. Second item 
3. Third item

Results in:

  1. First item

  2. Second item

  3. Third item

4. Links

[Link text](https://example.com)

Results in: Link text

5. Code Blocks

You can format code snippets in reconfigured by using the ```{prefix} shorthand.

To specify a language for syntax highlighting, add the language name after the triple backticks:

  • ```sql for SQL

  • ```py for Python

  • ```js for JavaScript

  • ```ts for TypeScript

Let us know if a language is missing and we'll add it.

For more details, refer to the Tiptap Markdown Shortcuts Guide.

Did this answer your question?