Initial import

2026-07-11 17:08:37 +00:00
commit 03e5f3452b
303 changed files with 43365 additions and 0 deletions
@@ -0,0 +1,31 @@
+---
+title: SyntaxHighlighting
+description: Syntax highlighting for code blocks.
+tags:
+  - plugin/transformer
+image: https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd
+repository: "[quartz-community/syntax-highlighting](https://github.com/quartz-community/syntax-highlighting)"
+enabled: true
+required: false
+---
+
+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`