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
No description
18 commits 1 branch 0 tags 3.9 MiB
TypeScript 95.7%
SCSS 4.3%
Find a file
saberzero1 16ef9c8d3d
fix: add build-time deps for DTS generation 
Peer dependencies needed at build time for TypeScript declaration file
generation were missing from devDependencies. Without them, the DTS build
fails silently, producing no index.d.ts.
2026-03-14 22:26:14 +01:00
.github/workflows Initial commit 2026-02-13 21:36:52 +01:00
dist fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
src feat: add render event listener for in-place DOM re-initialization 2026-03-12 19:45:37 +01:00
types fix: resolve ESLint and formatting issues for CI compliance 2026-03-09 03:46:58 +01:00
.eslintrc.json Initial commit 2026-02-13 21:36:52 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 22:01:39 +01:00
.prettierrc Initial commit 2026-02-13 21:36:52 +01:00
CHANGELOG.md Initial commit 2026-02-13 21:36:52 +01:00
LICENSE Initial commit 2026-02-13 21:36:52 +01:00
package-lock.json fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
package.json fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +01:00
tsconfig.json feat: add clipboard copy button for code blocks 2026-02-14 00:32:49 +01:00
tsup.config.ts fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@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

plugins:
  - source: github:quartz-community/syntax-highlighting
    enabled: true
    options:
      theme:
        light: github-light
        dark: github-dark
      keepBackground: false

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 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