mirror of
https://github.com/quartz-community/syntax-highlighting.git
synced 2026-11-17 00:14:08 +00:00
Quartz's default syntax highlighting plugin.
- TypeScript 95.7%
- SCSS 4.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@quartz-community/syntax-highlighting
Adds syntax highlighting to code blocks using rehype-pretty-code and Shiki, with an optional clipboard copy button.
Installation
npx quartz plugin add @quartz-community/syntax-highlighting
Syntax highlighting is already in Quartz's default configuration.
Usage
plugins:
- source: "@quartz-community/syntax-highlighting"
enabled: true
options:
theme:
light: github-light
dark: github-dark
keepBackground: false
order: 20
For advanced use cases, you can override in TypeScript:
import * as ExternalPlugin from "./.quartz/plugins";
ExternalPlugin.SyntaxHighlighting({
theme: { light: "github-light", dark: "github-dark" },
keepBackground: false,
});
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
theme |
{ light: CodeTheme, dark: CodeTheme } |
{ light: "github-light", dark: "github-dark" } |
The Shiki themes to use in light and dark mode. |
keepBackground |
boolean |
false |
Whether to keep the background color of the code block. |
clipboard |
boolean |
true |
Whether to add a clipboard copy button to code blocks. |
tokenClassification |
boolean |
true |
Adds data-token-type attributes (keyword, string, comment, etc.) to token spans. Enables theme-aware code styling via CSS selectors. |
Documentation
See the Quartz documentation for more information.
License
MIT