Quartz's default obsidian flavored markdown plugin.
  • TypeScript 94.2%
  • SCSS 5.8%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-10 00:06:17 +01:00
.changeset chore: version package 2026-11-09 23:05:14 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:25 +01:00
src fix: mark wikilinks for rehype-obsidian's block ids; wikilink image alt defaults to the path (Obsidian 1.15.0) 2026-11-09 15:57:06 +01:00
test fix: mark wikilinks for rehype-obsidian's block ids; wikilink image alt defaults to the path (Obsidian 1.15.0) 2026-11-09 15:57:06 +01:00
types fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
.eslintrc.json fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:21 +02:00
.prettierignore fix: centralize type declarations and add missing dependencies 2026-03-16 18:54:32 +01:00
.prettierrc Initial commit 2026-02-13 21:42:00 +01:00
CHANGELOG.md chore: version package 2026-11-09 23:05:14 +00:00
LICENSE Initial commit 2026-02-13 21:42:00 +01:00
package-lock.json chore: version package 2026-11-09 23:05:14 +00:00
package.json chore: version package 2026-11-09 23:05:14 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:49 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json feat: extract Obsidian Flavored Markdown transformer from Quartz core 2026-02-13 22:31:29 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:51:15 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/obsidian-flavored-markdown

Transforms Obsidian-specific markdown syntax including wikilinks, callouts, highlights, Mermaid diagrams, tags, and media embeds.

Mermaid fences use Mermaid.js by default. Set diagramRenderer: pele to use Pele instead. Mermaid.js is deprecated and will move to Pele later.

Both renderers are only loaded on pages with a Mermaid fence. On Quartz 5.1+ Pele is self-hosted (shipped as a plugin asset to static/plugins/obsidian-flavored-markdown/pele/) and fetches only the code for the diagram types on the page; on older Quartz versions it is loaded from jsDelivr, as Mermaid.js always is.

Installation

npx quartz plugin add @quartz-community/obsidian-flavored-markdown

Usage

This plugin is already enabled in the default quartz.config.yaml:

plugins:
  - source: "@quartz-community/obsidian-flavored-markdown"
    enabled: true
    options:
      enableInHtmlEmbed: false
      enableCheckbox: true
      # diagramRenderer: pele
    order: 40

This plugin must run after github-flavored-markdown (order 40 and 30 in the default config): where both claim the same syntax (~~ strikethrough, for example), the plugin registered later wins.

Configuration

Option Type Default Description
preset "legacy" | "strict" "legacy" legacy: parse exactly as Obsidian. strict: CommonMark/GFM + Obsidian syntax, keeps other plugins' syntax extensions (TOML frontmatter).
strictLineBreaks boolean by preset Obsidian's "Strict line breaks": false (default under legacy) renders a single line break as <br>; true (default under strict) as a space.
comments boolean true Whether to parse Obsidian-style comments.
highlight boolean true Whether to parse Obsidian-style highlights.
wikilinks boolean true Whether to parse wikilinks.
callouts boolean true Whether to parse callouts.
mermaid boolean true Whether to parse Mermaid diagram fences.
diagramRenderer "mermaid" | "pele" "mermaid" Renderer for Mermaid fences. Default Mermaid.js; Pele is opt-in (Mermaid.js deprecated).
parseTags boolean true Whether to parse tags.
parseBlockReferences boolean true Whether to parse block references.
enableInHtmlEmbed boolean false Whether to enable parsing in HTML embeds.
enableYouTubeEmbed boolean true Whether to enable YouTube embeds.
enableTweetEmbed boolean true Whether to embed tweets (Twitter/X URLs) as static blockquotes.
enableVideoEmbed boolean true Whether to enable video embeds.
enableCheckbox boolean false Whether to enable interactive checkboxes, incl. custom task characters (- [?]). The default quartz.config.yaml turns it on.
enableObsidianUri boolean true Whether to mark obsidian:// links with a CSS class and data attribute.

disableBrokenWikilinks is no longer an option of this plugin: it is part of Quartz's built-in link processing, as configuration.links.disableBrokenWikilinks.

Documentation

See the Quartz documentation for more information.

License

MIT