quartz-community/syntax-highlighting
1
0
Fork 0
mirror of https://github.com/quartz-community/syntax-highlighting.git synced 2026-07-22 02:50:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README for v5 unified config system

Browse source
This commit is contained in:
saberzero1 2026-02-25 16:07:03 +01:00
parent 1919588a82
commit 9b220b6d0c
No known key found for this signature in database
1 changed files with 25 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -10,30 +10,39 @@ npx quartz plugin add github:quartz-community/syntax-highlighting
## Usage
```ts
// quartz.config.ts
import * as ExternalPlugin from "./.quartz/plugins"
```yaml title="quartz.config.yaml"
plugins:
- source: github:quartz-community/syntax-highlighting
enabled: true
options:
theme:
light: github-light
dark: github-dark
keepBackground: false
```
const config: QuartzConfig = {
plugins: {
transformers: [
ExternalPlugin.SyntaxHighlighting(),
],
},
}
For advanced use cases, you can override in TypeScript:
```ts title="quartz.ts (override)"
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 theme to use for syntax highlighting. |
| 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. |
| Option | Type | Default | Description |
| ---------------- | --------------------------------------- | ------------------------------------------------ | ------------------------------------------------------- |
| `theme` | `{ light: CodeTheme, dark: CodeTheme }` | `{ light: "github-light", dark: "github-dark" }` | The theme to use for syntax highlighting. |
| `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. |
## Documentation
See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information.
See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/SyntaxHighlighting) for more information.
## License