cce45e0718
Added repository, enabled, and required fields to the frontmatter of all 44 plugin documentation files. Updated Plugins.base to include these columns, matching the information previously in the manual tables. Also filtered out internal plugins (Assets, Static, ComponentResources, NotFoundPage) from the base query.
29 lines
1.2 KiB
Markdown
29 lines
1.2 KiB
Markdown
---
|
|
title: GitHubFlavoredMarkdown
|
|
tags:
|
|
- plugin/transformer
|
|
image:
|
|
repository: "quartz-community/github-flavored-markdown"
|
|
enabled: true
|
|
required: false
|
|
---
|
|
|
|
This plugin enhances Markdown processing to support GitHub Flavored Markdown (GFM) which adds features like autolink literals, footnotes, strikethrough, tables and tasklists.
|
|
|
|
In addition, this plugin adds optional features for typographic refinement (such as converting straight quotes to curly quotes, dashes to en-dashes/em-dashes, and ellipses) and automatic heading links as a symbol that appears next to the heading on hover.
|
|
|
|
> [!note]
|
|
> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
|
|
|
|
This plugin accepts the following configuration options:
|
|
|
|
- `enableSmartyPants`: When true, enables typographic enhancements. Default is true.
|
|
- `linkHeadings`: When true, automatically adds links to headings. Default is true.
|
|
|
|
## API
|
|
|
|
- Category: Transformer
|
|
- Function name: `ExternalPlugin.GitHubFlavoredMarkdown()`.
|
|
- Source: [`quartz-community/github-flavored-markdown`](https://github.com/quartz-community/github-flavored-markdown)
|
|
- Install: `npx quartz plugin add github:quartz-community/github-flavored-markdown`
|