alrayyes/wiki
1
0
Fork 0
mirror of https://github.com/alrayyes/wiki.git synced 2024-11-23 03:56:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
wiki/docs/plugins/OxHugoFlavoredMarkdown.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.5 KiB
Raw Blame History

title tags
OxHugoFlavoredMarkdown
plugin/transformer

This plugin provides support for ox-hugo compatibility. See OxHugo compatibility for more information.

Note

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

This plugin accepts the following configuration options:

  • wikilinks: If true (default), converts Hugo {{ relref }} shortcodes to Quartz wikilinks.
  • removePredefinedAnchor: If true (default), strips predefined anchors from headings.
  • removeHugoShortcode: If true (default), removes Hugo shortcode syntax ({{}}) from the content.
  • replaceFigureWithMdImg: If true (default), replaces <figure/> with ![]().
  • replaceOrgLatex: If true (default), converts Org-mode features/Latex fragments to Quartz-compatible LaTeX wrapped in $ (for inline) and $$ (for block equations).

Warning

While you can use this together with ObsidianFlavoredMarkdown, it's not recommended because it might mutate the file in unexpected ways. Use with caution.

If you use toml frontmatter, make sure to configure the Frontmatter plugin accordingly. See OxHugo compatibility for an example.

API