Markdown Basic is a custom editor for Standard Notes, a free, open-source, and end-to-end encrypted notes app.
- Markdown via Markdown-It
- Syntax Highlighting via Highlight.js
- Optional split pane view
- Task Lists
- Tables
- Footnotes
- Inline external images
- 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, and you are done!
After you have installed the editor on the web or desktop app, it will automatically sync to your mobile app after you log in.
| 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 *** |
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! 😆 |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.- KaTeX
- Printing
To use a custom font size for your editor and rendered text, add this to your note and specify your font size (16px is 12pt).
<style>:root {--sn-stylekit-font-size-editor: 16px}</style>To use a custom font for your editor, add this to your note:
<style> #editor {font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, "Ubuntu Mono", courier, monospace;} </style>To use a custom font for your rendered text, add this to your note:
<style> #preview {font-family: 'Times New Roman'} </style>GNU Affero General Public License v3.0
The instructions for local setup can be found here. All commands are performed in the root directory:
- Fork the repository on GitHub
- Clone your fork of the repository
- Type
cd markdown-basic - Run
npm installto locally install the packages inpackage.json - Create
ext.jsonas shown here withurl: "http://localhost:8004/dist/index.html". Optionally, create yourext.jsonas a copy ofext.json.sample. - Install http-server using
sudo npm install -g http-server - Start the server at
http://localhost:8004usingnpm run server - Import the extension into the web or desktop app with
http://localhost:8004/ext.json. - To build the editor, open another command window and run
npm run build. For live builds, usenpm run watch. You can also runnpm run startand open the editor athttp://localhost:8080.
- GitHub
- Issues and Feature Requests
- Standard Notes Slack (for connecting with the Standard Notes Community)
- Standard Notes Help Files (for issues related to Standard Notes but unrelated to this editor)