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
syntax-highlighting/README.md
saberzero1 92936ff025
docs: add plugin README
2026-02-14 02:12:58 +01:00

1,015 B
Raw Blame History

@quartz-community/syntax-highlighting

Adds syntax highlighting to code blocks using rehype-pretty-code, with an optional clipboard copy button.

Installation

npx quartz plugin add github:quartz-community/syntax-highlighting

Usage

// quartz.config.ts
import * as ExternalPlugin from "./.quartz/plugins"

const config: QuartzConfig = {
  plugins: {
    transformers: [
      ExternalPlugin.SyntaxHighlighting(),
    ],
  },
}

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.

Documentation

See the Quartz documentation for more information.

License

MIT