Quartz's default github flavored markdown plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:03:11 +01:00
.changeset chore: version package 2026-11-09 04:06:23 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:25 +01:00
src fix(headings): ids from the heading as written, Obsidian anchor aliases, same-page anchors (shared slugHeading from utils) 2026-11-08 19:21:05 +01:00
test fix(headings): ids from the heading as written, Obsidian anchor aliases, same-page anchors (shared slugHeading from utils) 2026-11-08 19:21:05 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:14 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 21:37:56 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:06:23 +00:00
LICENSE Initial commit 2026-02-13 21:37:56 +01:00
package-lock.json chore: version package 2026-11-09 04:06:23 +00:00
package.json chore: version package 2026-11-09 04:06:23 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:48 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-13 21:37:56 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:51:42 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/github-flavored-markdown

Adds GitHub Flavored Markdown support including autolink literals, footnotes, strikethrough, tables, task lists, SmartyPants typography and linked headings.

Installation

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

Usage

This plugin is already enabled in the default quartz.config.yaml:

plugins:
  - source: "@quartz-community/github-flavored-markdown"
    enabled: true
    options:
      enableSmartyPants: true
      linkHeadings: true
    order: 30

This plugin must run before obsidian-flavored-markdown (order 30 and 40 in the default config). If you set order on either plugin, keep this one first.

Configuration

Option Type Default Description
enableSmartyPants boolean true Typographic enhancements: curly quotes, en/em dashes, ellipses.
linkHeadings boolean true Gives headings their ids and adds an anchor link to each. false also turns off heading ids, so links to headings ([[page#Heading]]) and section embeds no longer reach them (the table of contents plugin still adds ids on pages that show it).

Heading ids

Heading ids are made from the heading as written, with the same slug function that links and the table of contents use, and match GitHub's and Obsidian's:

  • With SmartyPants on, a heading containing -- keeps it in its id: ## Range 1--2 → range-1--2 (before Quartz 5.1: range-12). [[page#Range 1--2]] keeps working.
  • Headings containing :, |, ^, # or \ get an extra anchor with the id Obsidian links use (spaces instead of those characters), so such links and section embeds reach them.
  • A same-page link written as a heading's text, such as [x](<#My Heading>), points at the heading's id.

Documentation

See the Quartz documentation for more information.

License

MIT