syntax reference

complete reference of markdown syntax supported by sublimated. see demo to view all features rendered.

headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

headings automatically get anchor IDs for linking: #heading-1, #heading-2, etc.

emphasis

**bold**
*italic*
~~strikethrough~~

links

[display text](https://example.com)
[relative link](./other-file.md)
https://example.com                   autolinked

images

![alt text](image.png)
![alt text](https://example.com/image.png)

images are served through the CDN with automatic format detection.

lists

- unordered item
- another item
  - nested item


1. ordered item
2. another item
   1. nested item

task lists

- [ ] incomplete task
- [x] completed task
- [ ] another task

rendered as interactive checkboxes.

tables

| Name    | Role     | Status |
|---------|----------|--------|
| Alice   | Engineer | Active |
| Bob     | Designer | Away   |

code

inline: `code`

fenced block with syntax highlighting:

```javascript
function hello() {
  console.log("hello");
}
```

blockquotes

> This is a blockquote.
>
> It can span multiple paragraphs.

horizontal rules

---

footnotes

Here is a statement[^1].


[^1]: This is the footnote content.

raw HTML

HTML tags pass through directly:

<details>
<summary>Click to expand</summary>


Hidden content here.


</details>

frontmatter

YAML metadata at the top of the file. supported by both Obsidian and iA Writer.

---
title: Page Title
description: A short description
tags: [tag1, tag2]
draft: false
---

wikilinks

internal links using Obsidian-style syntax:

[[page]]                  link to page.md
[[folder/page]]           link to folder/page.md
[[page|display text]]     link with custom text
[[page#heading]]          link to a heading
[[page#^blockid]]         link to a block

wikilinks resolve from your space root. see obsidian for more on how links work with vaults.

citations

reference bibliography entries using Pandoc-style syntax:

[@smith2024]              cite a reference
[-@smith2024]             suppress author name
[@smith2024, p. 42]       with locator
[@smith2024; @jones2023]  multiple references

requires a .bib file in your space. push a references.bib and cite from any markdown file. see citations for full details on .bib files and backlinks.

content blocks

embed other files inline. two syntaxes are supported:

Obsidian embeds:

![[file.png]]             embed a file
![[file.png|300]]         with width
![[file.png|300x200]]     with width and height
![[doc#heading]]          embed a section
![[doc^blockid]]          embed a block

iA Writer content blocks:

/data/chart.csv
/images/diagram.png
/diagrams/architecture.mmd

.mmd and .mermaid files embed as rendered SVG diagrams (planned — see mermaid).

see obsidian and ia-writer for full details on each syntax.

block IDs

stable anchors using Obsidian's ^id syntax:

This paragraph has an anchor. ^my-id


## This heading has an anchor ^intro

reference from other documents with [[page#^my-id]]. see obsidian for more on block references.