1# markdown
2
3sublimated renders markdown files when you browse them on the web. push `.md` files via git and they're displayed with full formatting.
4
5## supported syntax
5## what's supported
6
7standard markdown plus GitHub Flavored Markdown (GFM):
7standard markdown plus GitHub Flavored Markdown (GFM) — bold, italic, headings, links, images, lists, tables, task lists, code blocks, blockquotes, strikethrough, autolinks.
8
9- headings (`# h1` through `###### h6`)
10- bold, italic, strikethrough
11- links and images
12- ordered and unordered lists
13- task lists (`- [ ]` and `- [x]`)
14- tables
15- code blocks with syntax highlighting
16- blockquotes
17- horizontal rules
18- inline code
19- autolinks (URLs become clickable)
20
21## extensions
22
23beyond standard markdown, sublimated supports:
24
25- [frontmatter](#frontmatter) — YAML metadata at the top of files
26- [wikilinks](#wikilinks) — link between files with `[[page]]`
27- [citations](#citations) — reference .bib entries with `[@key]`
28- [content blocks](#content-blocks) — embed other files inline
29- [block IDs](#block-ids) — anchor to specific blocks with `^id`
9on top of that, sublimated adds:
10- frontmatter — YAML metadata at the top of files
11- wikilinks — link between files with `[[page]]`
12- citations — reference .bib entries with `[@key]`
13- content blocks — embed other files inline
14- block IDs — anchor to specific blocks with `^id`
15- raw HTML passthrough
16
32## frontmatter
17see [syntax](syntax.md) for the complete reference with examples.
18
34YAML between `---` delimiters at the top of a file:
35
36```markdown
37---
38title: My Post
39tags: [blog, update]
40draft: false
41---
42
43# My Post
44
45content here...
46```
47
48frontmatter is extracted and used for metadata — titles, descriptions, tags.
49
50## wikilinks
51
52link to other files in your space:
53
54```markdown
55[[pricing]]           links to pricing.md
56[[docs/setup]]        links to docs/setup.md
57[[setup|Get Started]] links to setup.md, displays "Get Started"
58```
59
60wikilinks resolve relative to your space root.
61
62## citations
63
64reference bibliography entries using Pandoc-style syntax:
65
66```markdown
67[@key]                normal citation
68[-@key]               suppress author name
69[@key, p. 42]         with page locator
70[@key1; @key2]        multiple citations
71```
72
73citations link to entries in `.bib` files in your space. push a `references.bib` file and cite from any markdown file.
74
75## content blocks
76
77embed other files inline. two syntaxes are supported:
78
79**iA Writer style:**
80
81```markdown
82/data/chart.csv
83/images/diagram.png
84```
85
86a path on its own line embeds that file.
87
88**Obsidian style:**
89
90```markdown
91![[chart.csv]]
92![[diagram.png]]
93![[diagram.png|300]]        with width
94![[diagram.png|300x200]]    with width and height
95![[doc#heading]]            embed a specific section
96![[doc^blockid]]            embed a specific block
97```
98
99see [obsidian](obsidian.md) and [ia-writer](ia-writer.md) for full compatibility details.
100
101## block IDs
102
103add stable anchors to any block using Obsidian's `^id` syntax:
104
105```markdown
106This is an important paragraph. ^important
107
108## Section heading ^intro
109```
110
111block IDs let you link to specific parts of a document: `[[page#^important]]`
112
19## editor compatibility
20
21sublimated works with markdown editors you already use:
22
2 unmodified lines
25- any editor that writes standard markdown or GFM
26
27## reference
28
123- [syntax](syntax.md) — complete syntax reference with examples
29- [syntax](syntax.md) — complete syntax reference
30- [demo](demo.md) — a live example file you can push to your space