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
6 commits 1 branch 0 tags 316 KiB
TypeScript 100%
Find a file
saberzero1 6474b1b1cf
fix: move tsup and typescript to dependencies for git install compatibility
2026-02-23 01:09:58 +01:00
.github/workflows Initial commit 2026-02-13 21:37:56 +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 Initial commit 2026-02-13 21:37:56 +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: update @quartz-community/types to v0.2.1 2026-02-13 22:55:37 +01:00
package.json fix: move tsup and typescript to dependencies for git install compatibility 2026-02-23 01:09:58 +01:00
README.md docs: add plugin README 2026-02-14 02:13:07 +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 Initial commit 2026-02-13 21:37:56 +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

// quartz.config.ts
import * as ExternalPlugin from "./.quartz/plugins"

const config: QuartzConfig = {
  plugins: {
    transformers: [
      ExternalPlugin.GitHubFlavoredMarkdown(),
    ],
  },
}

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