The Trans Directory
1---
2title: ObsidianFlavoredMarkdown
3tags:
4 - plugin/transformer
5---
6
7This plugin provides support for [[Obsidian compatibility]].
8
9> [!note]
10> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
11
12This plugin accepts the following configuration options:
13
14- `comments`: If `true` (default), enables parsing of `%%` style Obsidian comment blocks.
15- `highlight`: If `true` (default), enables parsing of `==` style highlights within content.
16- `wikilinks`:If `true` (default), turns [[wikilinks]] into regular links.
17- `callouts`: If `true` (default), adds support for [[callouts|callout]] blocks for emphasizing content.
18- `mermaid`: If `true` (default), enables [[Mermaid diagrams|Mermaid diagram]] rendering within Markdown files.
19- `parseTags`: If `true` (default), parses and links tags within the content.
20- `parseArrows`: If `true` (default), transforms arrow symbols into their HTML character equivalents.
21- `parseBlockReferences`: If `true` (default), handles block references, linking to specific content blocks.
22- `enableInHtmlEmbed`: If `true`, allows embedding of content directly within HTML. Defaults to `false`.
23- `enableYouTubeEmbed`: If `true` (default), enables the embedding of YouTube videos and playlists using external image Markdown syntax.
24- `enableVideoEmbed`: If `true` (default), enables the embedding of video files.
25- `enableCheckbox`: If `true`, adds support for interactive checkboxes in content. Defaults to `false`.
26- `disableBrokenWikilinks`: If `true`, replaces links to non-existent notes with a dimmed, disabled link. Defaults to `false`.
27
28> [!warning]
29> Don't remove this plugin if you're using [[Obsidian compatibility|Obsidian]] to author the content!
30
31## API
32
33- Category: Transformer
34- Function name: `Plugin.ObsidianFlavoredMarkdown()`.
35- Source: [`quartz/plugins/transformers/ofm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/ofm.ts)