github-flavored-markdown/README.md

1.1 KiB

@quartz-community/github-flavored-markdown

Adds GitHub Flavored Markdown support including tables, strikethrough, task lists, and autolinked headings.

Installation

npx quartz plugin add github:quartz-community/github-flavored-markdown

Usage

plugins:
  - source: github:quartz-community/github-flavored-markdown
    enabled: true

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.GitHubFlavoredMarkdown({
  enableSmartyPants: true,
  linkHeadings: true,
});

Configuration

Option Type Default Description
enableSmartyPants boolean true Whether to enable SmartyPants.
linkHeadings boolean true Whether to link headings.

Documentation

See the Quartz documentation for more information.

License

MIT