30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
|
---
|
||
|
|
title: "OxHugo Compatibility"
|
||
|
|
tags:
|
||
|
|
- 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 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: {
|
||
|
|
transformers: [
|
||
|
|
Plugin.FrontMatter({ delims: "+++", language: "toml" }), // if toml frontmatter
|
||
|
|
// ...
|
||
|
|
Plugin.OxHugoFlavouredMarkdown(),
|
||
|
|
Plugin.GitHubFlavoredMarkdown(),
|
||
|
|
// ...
|
||
|
|
],
|
||
|
|
},
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Quartz by default doesn't understand `org-roam` files as they aren't Markdown. You're responsible for using an external tool like `ox-hugo` to export the `org-roam` files as Markdown content to Quartz and managing the static assets so that they're available in the final output.
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
This functionality is provided by the [[OxHugoFlavoredMarkdown]] plugin. See the plugin page for customization options.
|