1
0
mirror of https://gitlab.com/MisterBiggs/brain-quartz.git synced 2025-07-25 07:41:30 +00:00
Files
.github
content
docs
advanced
features
images
plugins
AliasRedirects.md
Assets.md
CNAME.md
Citations.md
ComponentResources.md
ContentIndex.md
ContentPage.md
CrawlLinks.md
CreatedModifiedDate.md
CustomOgImages.md
Description.md
ExplicitPublish.md
FolderPage.md
Frontmatter.md
GitHubFlavoredMarkdown.md
HardLineBreaks.md
Latex.md
NotFoundPage.md
ObsidianFlavoredMarkdown.md
OxHugoFlavoredMarkdown.md
RemoveDrafts.md
RoamFlavoredMarkdown.md
Static.md
SyntaxHighlighting.md
TableOfContents.md
TagPage.md
index.md
tags
authoring content.md
build.md
configuration.md
hosting.md
index.md
layout-components.md
layout.md
migrating from Quartz 3.md
philosophy.md
setting up your GitHub repository.md
showcase.md
upgrading.md
quartz
.gitattributes
.gitignore
.node-version
.npmrc
.prettierignore
.prettierrc
CODE_OF_CONDUCT.md
Dockerfile
LICENSE.txt
README.md
globals.d.ts
index.d.ts
package-lock.json
package.json
quartz.config.ts
quartz.layout.ts
tsconfig.json
brain-quartz/docs/plugins/OxHugoFlavoredMarkdown.md
Race Williams dd82ab8d79 fix: broken doc links on /plugins/* ()
* Update Assets.md

* expand fix for every /plugins page
2024-04-03 13:30:41 -07:00

30 lines
1.5 KiB
Markdown

---
title: OxHugoFlavoredMarkdown
tags:
- plugin/transformer
---
This plugin provides support for [ox-hugo](https://github.com/kaushalmodi/ox-hugo) compatibility. See [[OxHugo compatibility]] for more information.
> [!note]
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] 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|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
- Category: Transformer
- Function name: `Plugin.OxHugoFlavoredMarkdown()`.
- Source: [`quartz/plugins/transformers/oxhugofm.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/oxhugofm.ts).