Markdown

A markup language supported by Notetxt for easy note formatting.

Notetxt features support for Markdown, 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 Markdown Cheat Sheet created by markdownguide.org, 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:

An image which shows off the side-by-side Markdown view with an example note.

While Notetxt supports most base Markdown syntax, it also supports and utilises a few plugins which allow you to extend your Markdown! 👇

---

Alerts

Alerts can notify a reader about something important or useful.

Notetxt uses the GitHub Alerts syntax for this plugin. The syntax is shown below:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

The alerts will be displayed as shown in the screenshot below:

The alerts from the above code displayed in the Markdown preview mode.

---

KaTeX (Math)

Notetxt includes support for KaTeX, a typesetting library which allows the rendering of math within your Markdown.

To utilise KaTeX in your Markdown, use the following syntax:

$$
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
$$

This will render the quadratic formula as shown below:

The quadratic formula displayed in Markdown with KaTeX.

---

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:

I :heart: Markdown because it makes writing notes easy and fun! :sparkles:

The emoji shortcode in the sentence will be displayed as shown below:

The displayed text and emoji in Markdown.

---

Frontmatter

While supported in Markdown, the raw YAML frontmatter and its markers will appear in previewed Markdown unless supported/handled correctly. On most websites, 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:

---
title: A Very Important Note
description: This is a very important note.
date: October 13, 2024
tags: ["important", "work", "priority:high"]
---

# A Very Important Note

This is a very important note that you absolutely have to
read right now! Pay close attention to the following steps outlined below:

1. This is Step 1.
2. [This is Step 2](https://www.youtube.com/watch?v=dQw4w9WgXcQ).

The Markdown that you will end up seeing in the Markdown preview will look as shown below:

A screenshot of the above example Markdown code displayed within Notetxt.

As evident from the screenshot, the frontmatter is hidden from the Markdown preview, while still displaying the rest of your note.