Obsidian Compatibility

obsidian_interop: native_transformers: - ObsidianFlavoredMarkdown - Frontmatter - CrawlLinks

Supported Features

Wikilinks

behavior:

• [[page]] → standard links
• details: wikilinks

syntax:

[[Page]] Link to a page
[[Page|Custom text]] Link with alias
[[Page#Heading]] Link to a heading
[[Page#Heading|Custom text]] Link to a heading with alias
[[Page#^block-id]] Link to a block reference
![[Page]] Embed (transclude) a page
![[image.png]] Embed an image
![[image.png|alt 100x200]] Embed with alt text and dimensions

tables:

• escape | as \|:

| Column          |
| --------------- |
| [[page\|alias]] |

Highlights

syntax:

• wrap text in ==

This is ==highlighted text== in a sentence.

render:

• This is highlighted text in a sentence.

Comments

behavior:

• Quartz strips Obsidian-style comments from output.

This is visible. %%This is a comment and won't appear.%%

render:

• This is visible.

%%
This entire block
is a comment.
%%

Tags

behavior:

• # tags link to tag pages.

#tag #nested/tag #tag-with-dashes

example:

• transformer

Note

Pure numeric tags (e.g. #123) are ignored.

Callouts

support:

• Obsidian callouts
• collapsible callouts

> [!note]
> 
> This is a note callout.
 
> [!warning]- Collapsed by default
> 
> This content is hidden initially.
 
> [!tip]+ Expanded by default
> 
> This content is visible initially.

Live example

This is a live callout rendered from Obsidian-flavored Markdown.

types:

• note, abstract, info, todo, tip, success, question, warning, failure, danger, bug, example, quote
• aliases: supported

Task Lists and Custom Task Characters

behavior:

• standard checkboxes: supported
• enableCheckbox: true: preserves custom task characters as data-task attributes

- [ ] Unchecked
- [x] Checked
- [?] Question
- [!] Important
- [>] Forwarded
- [/] In progress
- [-] Cancelled
- [s] Special

• Unchecked
• Checked
• Question
• Important

Mermaid Diagrams

behavior:

• Mermaid blocks render as diagrams.

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[OK]
    B -->|No| D[Cancel]
```

graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[OK]
    B -->|No| D[Cancel]

YouTube Embeds

syntax:

• use image syntax with YouTube URL

![](https://youtu.be/v5LGaczJaf0)
![](https://www.youtube.com/watch?v=v5LGaczJaf0)

render_source:

• ![](https://youtu.be/v5LGaczJaf0)

Tweet Embeds

behavior:

• embeds static blockquote with original link

![](https://x.com/kepano/status/1882142872826442145)
![](https://twitter.com/kepano/status/1882142872826442145)

render_source:

• ![](https://x.com/kepano/status/1882142872826442145)

Priorities for my personal site:

1. I can write and publish directly from Obsidian
2. I can preview the site offline
3. I can switch hosts easily, all the data is in my control

For a personal site I find that CMSes like Wordpress, Squarespace, and Webflow, add too much…

— kepano (@kepano) January 22, 2025

Block References

syntax:

Content paragraph. ^my-block
 
[[Page#^my-block]]

Obsidian URI Links

behavior:

• obsidian:// links get:
  • CSS class: obsidian-uri
  • attribute: data-obsidian-uri

Video Embeds

syntax:

• use image syntax with video files

![](video.mp4)
![](video.webm)

Embed in HTML

config:

• enableInHtmlEmbed: true: parse wikilinks, highlights, tags inside raw HTML nodes

Footnotes

source:

• GitHubFlavoredMarkdown

Here is a sentence with a footnote.[^1]
 
[^1]: This is the footnote content.

Obsidian Community Plugin Support

Obsidian Plugin	Quartz Support
Dataview	Quartz Syncer: exports queries during sync
Excalidraw	obsidian-plugin-excalidraw community plugin
Leaflet Maps	obsidian-plugin-leaflet community plugin
Style Settings	quartz-themes community plugin

Tip

Core features are native; community plugins require matching Quartz community plugins.

Configuration

details:

• ObsidianFlavoredMarkdown
• Frontmatter
• CrawlLinks