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

docs: update README for v5 unified config system

Browse source
This commit is contained in:
saberzero1 2026-02-25 16:07:03 +01:00
parent 6474b1b1cf
commit 764a27197e
No known key found for this signature in database
1 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -10,29 +10,33 @@ npx quartz plugin add github:quartz-community/github-flavored-markdown
## Usage
```ts
// quartz.config.ts
import * as ExternalPlugin from "./.quartz/plugins"
```yaml title="quartz.config.yaml"
plugins:
- source: github:quartz-community/github-flavored-markdown
enabled: true
```
const config: QuartzConfig = {
plugins: {
transformers: [
ExternalPlugin.GitHubFlavoredMarkdown(),
],
},
}
For advanced use cases, you can override in TypeScript:
```ts title="quartz.ts (override)"
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. |
| Option | Type | Default | Description |
| ------------------- | --------- | ------- | ------------------------------ |
| `enableSmartyPants` | `boolean` | `true` | Whether to enable SmartyPants. |
| `linkHeadings` | `boolean` | `true` | Whether to link headings. |
## Documentation
See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information.
See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/GitHubFlavoredMarkdown) for more information.
## License