4.5 KiB
4.5 KiB
id, title, sidebar_label, description, keywords, image, hide_title, hide_table_of_contents
| id | title | sidebar_label | description | keywords | image | hide_title | hide_table_of_contents | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| markdown-basic | Markdown Basic Editor | Markdown Basic | How to use the Standard Notes Markdown Basic editor. |
|
/img/logo.png | false | false |
Introduction
Markdown Basic is a custom editor for Standard Notes. It uses Markdown-It to parse Markdown.
Features
- Markdown via Markdown-It
- Syntax Highlighting via Highlight.js
- Optional split pane view
- Task Lists
- Tables
- Footnotes
- Inline external images
Installation
- Register for an account at Standard Notes using the Desktop App or Web app. Remember to use a strong and memorable password.
- Sign up for Standard Notes Extended. Then, follow the instructions here or continue.
- Click Extensions in the lower left corner.
- Under Repository, find Markdown Basic.
- Click Install.
- Close the Extensions pop-up.
- At the top of your note, click Editor, then click Markdown Basic.
- Click Continue.
After you have installed the editor on the web or desktop app, it will automatically sync to your mobile app after you sign in.
Style Guide
| Result | Markdown |
|---|---|
| Bold | **text** or __text__ |
| Emphasize | *text* or _text_ |
| ~~text~~ | |
| Link | [text](http://) |
| Image |  |
Inline Code |
`code` |
| Code Block | ```language code ``` |
| Unordered List | * item - item + item |
| Ordered List | 1. item |
| Task List | - [ ] Task or - [x] Task |
| Blockquote | > quote |
| H1 | # Heading |
| H2 | ## Heading |
| H3 | ### Heading |
| H4 | #### Heading |
| Section Breaks | --- or *** |
Tables
Colons can be used to align columns. Copy this into your editor to see what it renders:
| Tables | Are | Cool |
| ---------------- | :-----------: | --------: |
| col 2 is | centered | \$149 |
| col 3 is | right-aligned | \$4.17 |
| privacy is | neat | \$2.48 |
| rows don't need to |be pretty| what? |
| the last line is | unnecessary | really?
| one more | row | Yay! 😆
Footnotes
The Markdown Basic editor supports footnotes. The footnote links do not work properly on mobile. Copy this into your note to see how they're used:
You can create footnote references that are short[^1] or long.[^2]
You can also create them inline.^[which may be easier,
since you don't need to pick an identifier and move down to type the note]
The footnotes are automatically numbered at the bottom of your note,
but you'll need to manually number your superscripts.
Make sure to count your variable[^variable] footnotes.[^5]
[^1]: Here's a footnote.
[^2]: Here’s a footnote with multiple blocks.
Subsequent paragraphs are indented to show that they belong to the previous footnote.
{ eight spaces for some code }
The whole paragraph can be indented, or just the first
line. In this way, multi-paragraph footnotes work like
multi-paragraph list items.
This paragraph won’t be part of the footnote, because it
isn’t indented.
[^variable]: The variable footnote is the fourth footnote.
[^5]: This is the fifth footnote.
Not yet available:
- KaTeX
- Printing
- Custom Font Families
- Custom Font Sizes
- Superscript
- Subscript
Further Resources
- GitHub - Development instructions, license (AGPL-3.0-or-later), and source code.