Markdown
A markup language supported by Notetxt.
Notetxt features support for Markdown, a lightweight markup language created by John Gruber. It's commonly used when writing things such as documents, blogs, or notes.
To learn the syntax that Markdown uses, it's recommended that you read this Markdown Cheat Sheet created by markdownguide.org.
Notetxt allows you to preview your Markdown by doing Ctrl/Cmd + M
to see how it would look like in a normal setting.
While Notetxt supports all base Markdown syntax, including raw HTML, it also utilises a few plugins that allow you to extend your Markdown. 👇
Alerts
Alerts can notify a reader about something important by standing out. Notetxt uses the GitHub Alerts syntax for this. The syntax is shown below:
The above alerts will be displayed as shown below:
KaTeX / Math
Notetxt includes support for KaTeX, a typesetting library which allows the rendering of math within your Markdown.
To add math into your Markdown, use the following syntax:
This will be displayed as shown below:
Emoji Shortcodes
Notetxt includes support for emoji shortcodes, which certain platforms like GitHub use to display emoji's with a related name. You can view an emoji cheat sheet here, which contains every shortcode that is supported.
To add emoji shortcodes into your Markdown, use the following syntax:
The emoji shortcode in the sentence will be displayed as shown below:
Frontmatter
While supported in Markdown, the raw YAML frontmatter and its markers will appear in previewed Markdown unless supported correctly.
In Notetxt, frontmatter is hidden from being displayed in the Markdown Preview, but it is still in the contents of the note.
You can see an example of this below:
This only works with the ---
marker.
The Markdown that is shown will be as seen below:
This is the only content that will be displayed.
Last updated