1 Markdown Cheat Sheet
riomoo edited this page 2026-04-08 18:34:42 -04:00

Markdown Cheat Sheet

nt stores notes as plain Markdown files (.md). The nt show command renders a subset of Markdown with colour in the terminal. Notes also render natively on GitHub, Forgejo, Gitea, and any other Markdown-aware viewer.


Headings

# Heading 1
## Heading 2
### Heading 3

Terminal rendering:

Level Colour
H1 Bold yellow + ────────────────────────────────────────────────────────── rule
H2 Bold blue
H3 Bold cyan

Checkboxes

- [ ] Unchecked task
- [X] Checked task
  - [ ] Indented sub-task

Rendered with [ ] in yellow and [✓] in green.

See Checkboxes for CLI commands to toggle these.


[Link label](https://example.com)

In the terminal, renders as Link label (https://example.com) with the label in cyan and the URL in blue.


Emphasis

**bold text**
*italic text*

Bold is rendered with the terminal bold attribute; italic is rendered in yellow.


Tables

| Name   | Status   | Priority |
| ------ | -------- | -------- |
| Alice  | Active   | High     |
| Bob    | Pending  | Medium   |

The separator row (| --- | --- |) is rendered in blue; data rows are plain text.

Use nt add <note> table Col1 Col2 ... to insert an empty table from the command line.


Blockquotes

> This is a note or callout.

Blockquotes pass through as-is (no special colour in the terminal renderer).


Plain Text

Any line that does not match a special pattern is output as-is with inline bold/italic/link substitutions applied.


File Format

Notes are UTF-8 plain text. You can edit them with any editor, sync them with any tool, and view them on any Markdown platform. nt never adds proprietary front-matter or metadata.