1# syntax reference
2
3complete reference of markdown syntax supported by sublimated.
4
5## headings
6
7```markdown
8# Heading 1
9## Heading 2
10### Heading 3
11#### Heading 4
12##### Heading 5
13###### Heading 6
14```
15
16headings automatically get anchor IDs for linking: `#heading-1`, `#heading-2`, etc.
17
18## emphasis
19
20```markdown
21**bold**
22*italic*
23~~strikethrough~~
24```
25
26## links
27
28```markdown
29[display text](https://example.com)
30[relative link](./other-file.md)
31https://example.com                   autolinked
32```
33
34## images
35
36```markdown
37![alt text](image.png)
38![alt text](https://example.com/image.png)
39```
40
41images are served through the CDN with automatic format detection.
42
43## lists
44
45```markdown
46- unordered item
47- another item
48  - nested item
49
501. ordered item
512. another item
52   1. nested item
53```
54
55## task lists
56
57```markdown
58- [ ] incomplete task
59- [x] completed task
60- [ ] another task
61```
62
63rendered as interactive checkboxes.
64
65## tables
66
67```markdown
68| Name    | Role     | Status |
69|---------|----------|--------|
70| Alice   | Engineer | Active |
71| Bob     | Designer | Away   |
72```
73
74## code
75
76inline: `` `code` ``
77
78fenced block with syntax highlighting:
79
80````markdown
81```javascript
82function hello() {
83  console.log("hello");
84}
85```
86````
87
88## blockquotes
89
90```markdown
91> This is a blockquote.
92>
93> It can span multiple paragraphs.
94```
95
96## horizontal rules
97
98```markdown
99---
100```
101
102## footnotes
103
104```markdown
105Here is a statement[^1].
106
107[^1]: This is the footnote content.
108```
109
110## raw HTML
111
112HTML tags pass through directly:
113
114```markdown
115<details>
116<summary>Click to expand</summary>
117
118Hidden content here.
119
120</details>
121```
122
123## frontmatter
124
125YAML metadata at the top of the file:
126
127```markdown
128---
129title: Page Title
130description: A short description
131tags: [tag1, tag2]
132draft: false
133---
134```
135
136## wikilinks
137
138```markdown
139[[page]]                  link to page.md
140[[folder/page]]           link to folder/page.md
141[[page|display text]]     link with custom text
142[[page#heading]]          link to a heading
143[[page#^blockid]]         link to a block
144```
145
146## citations
147
148```markdown
149[@smith2024]              cite a reference
150[-@smith2024]             suppress author name
151[@smith2024, p. 42]       with locator
152[@smith2024; @jones2023]  multiple references
153```
154
155requires a `.bib` file in your space.
156
157## content blocks
158
159embed other files inline:
160
161```markdown
162![[file.png]]             Obsidian embed
163![[file.png|300]]         with width
164/data/chart.csv           iA Writer content block
165```
166
167## block IDs
168
169```markdown
170This paragraph has an anchor. ^my-id
171
172## This heading has an anchor ^intro
173```
174
175reference with `[[page#^my-id]]`.