mirror of
https://github.com/logos-co/assembly.git
synced 2026-09-01 13:41:13 +00:00
saberzero1
f681e871ea
- CreatedModifiedDate: add defaultDateType option - Description: add maxDescriptionLength option - Latex: add katexOptions, mathJaxOptions, typstOptions - SyntaxHighlighting: add clipboard and tokenClassification options - RoamFlavoredMarkdown: add tableComponent and attributeComponent
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
---
|
|
title: SyntaxHighlighting
|
|
tags:
|
|
- plugin/transformer
|
|
image: https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd
|
|
---
|
|
|
|
This plugin is used to add syntax highlighting to code blocks in Quartz. See [[syntax highlighting]] 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:
|
|
|
|
- `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.
|
|
|
|
## API
|
|
|
|
- Category: Transformer
|
|
- Function name: `ExternalPlugin.SyntaxHighlighting()`.
|
|
- Source: [`quartz-community/syntax-highlighting`](https://github.com/quartz-community/syntax-highlighting)
|
|
- Install: `npx quartz plugin add github:quartz-community/syntax-highlighting`
|