Markdown
A markup language supported by Notetxt for easy note formatting.
Last updated
Was this helpful?
A markup language supported by Notetxt for easy note formatting.
Last updated
Was this helpful?
Notetxt features support for , a lightweight markup language created by John Gruber. It is most commonly used when writing things such as documents, blogs, or notes.
To learn the syntax that Markdown uses, I recommend reading the created by , which contains various examples of syntax being used as well.
In Notetxt, you are able to view your note in a side-by-side Markdown view, while also being able to simultaneously edit your note and see the Markdown rendered in real-time! See an example below:
While Notetxt supports most base Markdown syntax, it also supports and utilises a few extensions which allow you to extend your Markdown! 👇
Alerts can notify a reader about something important or useful.
The alerts will be displayed as shown in the screenshot below:
Notetxt includes support for KaTeX, a typesetting library which allows the rendering of math within your Markdown. To utilise it in your Markdown, use the $$ syntax:
The above example will render the quadratic formula as shown below:
To add them into your Markdown, use the correct shortcode, like this example:
The emoji shortcodes in the example above will be displayed as shown below:
While supported in Markdown, the raw YAML frontmatter and its markers will appear in previewed Markdown unless supported/handled correctly.
On most websites that use Markdown previews, frontmatter is hidden from being displayed in the Markdown, but is still within the raw contents of the file. This also applies to Notetxt. You can confirm this by viewing the Markdown preview and note content at the same time.
This will only work with the --- marker.
For example, say we have the following Markdown:
The Markdown that you will end up seeing in the Markdown preview will look as shown below:
As evident from the screenshot, the frontmatter is hidden from the Markdown preview, while still displaying the rest of your note.
When parsed, dates will be displayed in full.
This works with many different types of date formats, and even natural language! You can try some of these examples below:
Notetxt uses the syntax for this plugin. The syntax is shown below:
Notetxt includes support for emoji shortcodes, which certain platforms like use to display emoji's with a related name. You can view an emoji cheat sheet , which contains every shortcode that is supported.
Notetxt uses in order to parse date and time formats from given text and reference dates within your notes. Use the following syntax to reference dates:
