alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2024-11-22 11:36:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
wiki/docs/features/Obsidian compatibility.md
jeff 88194ac348
feat: allow embedding youtube videos with the obsidian markdown syntax (#665) 
* Add option to allow embedding YouTube videos with Obsidian Markdown syntax

* Update Obsidian compatability doc page

* Switch to converting YT links as an html plugin
2024-01-02 10:49:14 -08:00

2.3 KiB
Raw Blame History

tags
plugin/transformer

Quartz was originally designed as a tool to publish Obsidian vaults as websites. Even as the scope of Quartz has widened over time, it hasn't lost the ability to seamlessly interoperate with Obsidian.

By default, Quartz ships with Plugin.ObsidianFlavoredMarkdown which is a transformer plugin that adds support for Obsidian Flavored Markdown. This includes support for features like wikilinks and Mermaid diagrams.

It also ships with support for frontmatter parsing with the same fields that Obsidian uses through the Plugin.FrontMatter transformer plugin.

Finally, Quartz also provides Plugin.CrawlLinks which allows you to customize Quartz's link resolution behaviour to match Obsidian.

Configuration

  • Frontmatter parsing:
    • Disabling: remove all instances of Plugin.FrontMatter() from quartz.config.ts.
    • Customize default values for frontmatter: edit quartz/plugins/transformers/frontmatter.ts
  • Obsidian Flavored Markdown:
    • Disabling: remove all instances of Plugin.ObsidianFlavoredMarkdown() from quartz.config.ts
    • Customizing features: Plugin.ObsidianFlavoredMarkdown has several other options to toggle on and off:
      • comments: whether to enable %% style Obsidian comments. Defaults to true
      • highlight: whether to enable == style highlights. Defaults to true
      • wikilinks: whether to enable turning wikilinks into regular links. Defaults to true
      • callouts: whether to enable callouts. Defaults to true
      • mermaid: whether to enable Mermaid diagrams. Defaults to true
      • parseTags: whether to try and parse tags in the content body. Defaults to true
      • enableInHtmlEmbed: whether to try and parse Obsidian flavoured markdown in raw HTML. Defaults to false
      • enableYouTubeEmbed: whether to enable embedded YouTube videos using external image Markdown syntax. Defaults to false
  • Link resolution behaviour:
    • Disabling: remove all instances of Plugin.CrawlLinks() from quartz.config.ts
    • Changing link resolution preference: set markdownLinkResolution to one of absolute, relative or shortest