quartz-community/github-flavored-markdown
1
0
Fork 0
mirror of https://github.com/quartz-community/github-flavored-markdown.git synced 2026-07-22 02:50:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
26 commits 1 branch 0 tags 316 KiB
TypeScript 100%
Find a file
saberzero1 3eabbaa252
chore: regenerate package-lock.json
2026-05-24 17:32:52 +02:00
.github/workflows build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:59 +02:00
dist fix: bundle non-shared deps into dist to prevent runtime resolution failures 2026-03-17 19:31:51 +01:00
src feat: extract github flavored markdown transformer from Quartz core 2026-02-13 22:31:03 +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: commit dist/ and remove prepare script 2026-03-14 21:58:48 +01: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 Initial commit 2026-02-13 21:37:56 +01:00
LICENSE Initial commit 2026-02-13 21:37:56 +01:00
package-lock.json chore: regenerate package-lock.json 2026-05-24 17:32:52 +02:00
package.json chore: remove vestigial @jackyzha0/quartz peerDependency 2026-05-24 16:24:07 +02:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +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: bundle dependencies and ship pre-built dist 2026-04-27 21:37:59 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

README.md

@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