Initial commit

docs/plugins/SyntaxHighlighting.md

@@ -0,0 +1,23 @@
+---
+title: "SyntaxHighlighting"
+tags:
+  - plugin/transformer
+---
+
+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.
+
+In addition, you can further override the colours in the `quartz/styles/syntax.scss` file.
+
+## API
+
+- Category: Transformer
+- Function name: `Plugin.SyntaxHighlighting()`.
+- Source: [`quartz/plugins/transformers/syntax.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/syntax.ts).