Skip to content

Markdown reference

Shady Notes follows CommonMark with GitHub-flavoured extensions, plus a few additions of its own.

Screenshot markdown-kitchen-sink.png

A note demonstrating every supported Markdown feature rendered in the editor.

Syntax Renders as
**bold** bold
*italic* italic
`inline code` inline code
~~strikethrough~~ strikethrough
==highlight== highlighted background
[text](https://example.com) a clickable link
[[wikilink]] a link to another note
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5

Five levels, each scaled and weighted differently. ⌥⌘1 through ⌥⌘5 apply them to the current line.

- Bullet item
* Also a bullet
1. Numbered item

Lists continue automatically on Return. Turn that off in Preferences → Editor if you’d rather they didn’t.

- [ ] Unchecked
- [x] Checked
[ ] Standalone, no list marker needed

Checkboxes

> An ordinary blockquote.
> [!TIP]
> A typed callout, with an icon and colour.

Callouts

```swift
let greeting = "Hello, world"
```
| Column | Column |
|---|---|
| cell | cell |

Tables

![alt text](path/to/image.png)
![[image.png|400]]

The second form is a wikilink-style embed with an explicit width in pixels. → Images

Type :name: for an emoji, or :name|32: to set its size in points. /emoji opens a picker.

---

A YAML block at the very top of a file is treated as metadata rather than content:

---
status: in-progress
tags: [docs, launch]
---

Plugins read these fields — the Kanban board builds its columns from status. → Plugins

Documented against Shady Notes 4.1.19 · release notes