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
13 commits 1 branch 0 tags 316 KiB
TypeScript 100%
Find a file
saberzero1 4a3269e468
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:37:56 +01:00
dist fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
src feat: extract github flavored markdown transformer from Quartz core 2026-02-13 22:31:03 +01:00
.eslintrc.json Initial commit 2026-02-13 21:37:56 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 21:58:48 +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 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 Initial commit 2026-02-13 21:37:56 +01:00
tsup.config.ts feat: extract github flavored markdown transformer from Quartz core 2026-02-13 22:31:03 +01: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