quartz-community/quartz
1
0
Fork 0
mirror of https://github.com/jackyzha0/quartz.git synced 2026-07-22 03:00:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
quartz/docs/plugins/SyntaxHighlighting.md
saberzero1 f681e871ea
docs: add missing options to transformer plugin documentation 
- CreatedModifiedDate: add defaultDateType option
- Description: add maxDescriptionLength option
- Latex: add katexOptions, mathJaxOptions, typstOptions
- SyntaxHighlighting: add clipboard and tokenClassification options
- RoamFlavoredMarkdown: add tableComponent and attributeComponent
2026-05-22 20:07:48 +02:00

1.4 KiB
Raw Blame History

title tags image
SyntaxHighlighting
plugin/transformer
https://images.unsplash.com/photo-1580569214296-5cf2bffc5ccd

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

This plugin accepts the following configuration options:

  • theme: a separate id of one of the themes bundled with Shikiji. 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.
  • clipboard: Whether to add a copy-to-clipboard button to code blocks. Defaults to true.
  • tokenClassification: Whether to add semantic token classification CSS classes to code tokens. Defaults to true.

In addition, you can further override the colours in the quartz/styles/syntax.scss file.

API

  • Category: Transformer
  • Function name: ExternalPlugin.SyntaxHighlighting().
  • Source: quartz-community/syntax-highlighting
  • Install: npx quartz plugin add github:quartz-community/syntax-highlighting