> For the complete documentation index, see [llms.txt](https://inttter.gitbook.io/notetxt/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://inttter.gitbook.io/notetxt/main/markdown.md).

# Markdown

Notetxt features support for [Markdown](https://en.wikipedia.org/wiki/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](https://www.markdownguide.org/cheat-sheet/) created by [markdownguide.org](https://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:

<figure><img src="/files/5h6rT5PBGMlpq1haZN9d" alt=""><figcaption><p>The aformentioned side-by-side Markdown preview being used on a note.</p></figcaption></figure>

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

***

## Alerts

Alerts can notify a reader about something important or useful.

Notetxt uses the [GitHub Alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) syntax for this plugin. The syntax is shown below:

```markdown
> [!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:

<figure><img src="/files/j1jdWgtDodDtCZXX5pIe" alt=""><figcaption><p>The alerts from the above code displayed in the Markdown preview.</p></figcaption></figure>

***

## KaTeX (Math)

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:

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

The above example will render the quadratic formula as shown below:

<figure><img src="/files/4TIjaTerv1AB4BFVa2cZ" alt=""><figcaption><p>The quadratic formula displayed in Markdown.</p></figcaption></figure>

***

## Emoji Shortcodes

Notetxt includes support for emoji shortcodes, which certain platforms like [GitHub](https://github.com) use to display emoji's with a related name. You can view an emoji cheat sheet [here](https://github.com/ikatyang/emoji-cheat-sheet), which contains every shortcode that is supported.&#x20;

To add them into your Markdown, use the correct shortcode, like this example:

```markdown
**I :heart: Markdown** because it helps me keep track of things, like **birthdays :tada:** 
or where I will go holiday to next, like **Japan :japan:**, or even somewhere else 
**around the globe :earth_americas:** if I feel like it.
```

The emoji shortcodes in the example above will be displayed as shown below:

<figure><img src="/files/SxVO0gihQr0vxOOdNt3A" alt=""><figcaption><p>The example sentence displayed in Markdown.</p></figcaption></figure>

***

## Frontmatter

While supported in Markdown, the raw YAML frontmatter and its markers will appear in previewed Markdown unless supported/handled correctly.&#x20;

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.

{% hint style="warning" %}
This will only work with the `---` marker.
{% endhint %}

For example, say we have the following Markdown:

```markdown
---
title: January To-Do List
description: A to-do list for the month of January 2025.
date: Sunday, 4th January 2025
tags: ["todo", "tasks", "january", "personal", "important"]
---

## To-Do List

This is the current to-do list for January.
Make sure these are all completed by the end of the month.

- [ ] Complete all of the anime I'm currently watching
- [X] Purchase a new SSD for the main computer
- [ ] Finish editing the video production project
```

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

<figure><img src="/files/BMtBGXAHbmqDWAMYXMpm" alt=""><figcaption><p>The Markdown example as seen within the Markdown preview.</p></figcaption></figure>

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

***

## Dates

Notetxt uses [chrono](https://github.com/wanasit/chrono) in order to parse date and time formats from given text and reference dates within your notes. Use the following syntax to reference dates:

<pre class="language-bash"><code class="lang-bash"><strong># Will show tommorow's date
</strong><strong>[[tommorow]]
</strong></code></pre>

When parsed, dates will be displayed in full.&#x20;

{% hint style="info" %}
When dates are parsed, they will be returned in the following format:

```
    Month Day, Year
eg. January 19, 2025  
```

{% endhint %}

This works with many different types of date formats, and even natural language! You can try some of these examples below:

<pre><code>[[1 week from now]]
[[31/12/23]]
[[2025-01-25]]
<strong>[[last saturday]]
</strong>[[10 years and 10 days ago]]
</code></pre>