zaine/quartz
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add missing options to transformer plugin documentation

Browse Source 
- CreatedModifiedDate: add defaultDateType option
- Description: add maxDescriptionLength option
- Latex: add katexOptions, mathJaxOptions, typstOptions
- SyntaxHighlighting: add clipboard and tokenClassification options
- RoamFlavoredMarkdown: add tableComponent and attributeComponent
This commit is contained in:
saberzero1
2026-05-22 20:07:48 +02:00
parent bc1c6a47d8
commit f681e871ea
5 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/plugins/SyntaxHighlighting.md
View File

@@ -12,8 +12,10 @@ This plugin is used to add syntax highlighting to code blocks in Quartz. See [[s
This plugin accepts the following configuration options:
- `theme`: a separate id of one of the [themes bundled with Shikiji](https://shikiji.netlify.app/themes). One for light mode and one for dark mode. Defaults to `theme: { light: "github-light", dark: "github-dark" }`.
- `theme`: a separate id of one of the [themes bundled with Shikiji](https://shikiji.netlify.app/themes). One for light mode and one for dark mode. Defaults to `theme: { light: "github-light", dark: "github-dark" }`.
- `keepBackground`: If set to `true`, the background of the Shikiji theme will be used. With `false` (default) the Quartz theme color for background will be used instead.
- `clipboard`: Whether to add a copy-to-clipboard button to code blocks. Defaults to `true`.
- `tokenClassification`: Whether to add semantic token classification CSS classes to code tokens. Defaults to `true`.
In addition, you can further override the colours in the `quartz/styles/syntax.scss` file.