From 1929241a62b67ebd9cc9831e372ab321874d03d1 Mon Sep 17 00:00:00 2001
From: Eiko Wagenknecht <git@eiko-wagenknecht.de>
Date: Fri, 23 Feb 2024 20:07:53 +0000
Subject: [PATCH] docs: update plugin documentation (#888)
---
docs/features/OxHugo compatibility.md | 18 ++++--------------
1 files changed, 4 insertions(+), 14 deletions(-)
diff --git a/docs/features/OxHugo compatibility.md b/docs/features/OxHugo compatibility.md
index 3143eb1..e220511 100644
--- a/docs/features/OxHugo compatibility.md
+++ b/docs/features/OxHugo compatibility.md
@@ -1,11 +1,12 @@
---
+title: "OxHugo Compatibility"
tags:
- - plugin/transformer
+ - feature/transformer
---
[org-roam](https://www.orgroam.com/) is a plain-text personal knowledge management system for [emacs](https://en.wikipedia.org/wiki/Emacs). [ox-hugo](https://github.com/kaushalmodi/ox-hugo) is org exporter backend that exports `org-mode` files to [Hugo](https://gohugo.io/) compatible Markdown.
-Because the Markdown generated by ox-hugo is not pure Markdown but Hugo specific, we need to transform it to fit into Quartz. This is done by `Plugin.OxHugoFlavouredMarkdown`. Even though this [[making plugins|plugin]] was written with `ox-hugo` in mind, it should work for any Hugo specific Markdown.
+Because the Markdown generated by ox-hugo is not pure Markdown but Hugo specific, we need to transform it to fit into Quartz. This is done by the [[OxHugoFlavoredMarkdown]] plugin. Even though this plugin was written with `ox-hugo` in mind, it should work for any Hugo specific Markdown.
```typescript title="quartz.config.ts"
plugins: {
@@ -25,15 +26,4 @@
## Configuration
-- Link resolution
- - `wikilinks`: Whether to replace `{{ relref }}` with Quartz [[wikilinks]]
- - `removePredefinedAnchor`: Whether to remove [pre-defined anchor set by ox-hugo](https://ox-hugo.scripter.co/doc/anchors/).
-- Image handling
- - `replaceFigureWithMdImg`: Whether to replace `<figure/>` with `![]()`
-- Formatting
- - `removeHugoShortcode`: Whether to remove hugo shortcode syntax (`{{}}`)
- - `replaceOrgLatex`: Whether to replace org-mode formatting for latex fragments with what `Plugin.Latex` supports.
-
-> [!warning]
->
-> While you can use `Plugin.OxHugoFlavoredMarkdown` and `Plugin.ObsidianFlavoredMarkdown` together, it's not recommended because it might mutate the file in unexpected ways. Use with caution.
+This functionality is provided by the [[OxHugoFlavoredMarkdown]] plugin. See the plugin page for customization options.
--
Gitblit v1.10.0