@quartz-community/obsidian-flavored-markdown

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

Installation

npx quartz plugin add github:quartz-community/obsidian-flavored-markdown

Usage

plugins:
  - source: github:quartz-community/obsidian-flavored-markdown
    enabled: true
    options:
      enableInHtmlEmbed: false
      enableCheckbox: true

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.ObsidianFlavoredMarkdown({
  enableInHtmlEmbed: false,
  enableCheckbox: true,
});

Configuration

| Option | Type | Default | Description | | ---------------------- | --------- | ------- | ------------------------------------------- | | 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 diagrams. | | 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. | | enableVideoEmbed | boolean | true | Whether to enable video embeds. | | enableCheckbox | boolean | false | Whether to enable checkboxes. |

Documentation

See the Quartz documentation for more information.

License

MIT