j/cyberware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
cyberware/docs/plugins/ObsidianFlavoredMarkdown.md
Eiko Wagenknecht 1929241a62
docs: update plugin documentation (#888) 
* docs: first few plugins documented

* docs: move plugin info

* docs: move plugin docs to tag based system

* docs: update latex example code snippet

* docs: fix spelling of latex in title

* docs: add missing linebreak

* docs: remove plugin tag from feature pages

* docs: shorten titles

* docs: refine wording

* docs: move plugin details for frontmatter

* docs: add features/* tags

* docs: update latex example

* docs: make references more explicit

* docs: add stubs for the remaining plugins

* docs: more descriptions

* docs: fix feature tags

* docs: descriptions

* docs: new plugin pages

* docs: update configuration page

* docs: more plugin work

* docs: run prettier

* docs: remove comments in config file and add link to docs

* docs: minor fixes

* docs: run prettier

* docs: spelling

* docs: update docs/plugins/AliasRedirects.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/Assets.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/CNAME.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/Static.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs

* docs: update docs/features/Mermaid diagrams.md

Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>

* docs: update docs/plugins/RemoveDrafts.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/plugins/Assets.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/configuration.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/configuration.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: update docs/configuration.md

Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>

* docs: some updates

* docs: work in review comments

---------

Signed-off-by: Eiko Wagenknecht <git@eiko-wagenknecht.de>
Co-authored-by: Aaron Pham <29749331+aarnphm@users.noreply.github.com>
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
2024-02-23 12:07:53 -08:00

1.8 KiB
Raw Blame History

title tags
ObsidianFlavoredMarkdown
plugin/transformer

This plugin provides support for Obsidian compatibility.

Note

For information on how to add, remove or configure plugins, see the Configuration#Plugins page.

This plugin accepts the following configuration options:

  • comments: If true (default), enables parsing of %% style Obsidian comment blocks.
  • highlight: If true (default), enables parsing of == style highlights within content.
  • wikilinks:If true (default), turns wikilinks into regular links.
  • callouts: If true (default), adds support for callouts blocks for emphasizing content.
  • mermaid: If true (default), enables Mermaid diagrams rendering within Markdown files.
  • parseTags: If true (default), parses and links tags within the content.
  • parseArrows: If true (default), transforms arrow symbols into their HTML character equivalents.
  • parseBlockReferences: If true (default), handles block references, linking to specific content blocks.
  • enableInHtmlEmbed: If true, allows embedding of content directly within HTML. Defaults to false.
  • enableYouTubeEmbed: If true (default), enables the embedding of YouTube videos using external image Markdown syntax.
  • enableVideoEmbed: If true (default), enables the embedding of video files.
  • enableCheckbox: If true, adds support for interactive checkboxes in content. Defaults to false.

Warning

Don't remove this plugin if you're using Obsidian compatibility to author the content!

API