mirror of
https://github.com/quartz-community/tag-page.git
synced 2026-07-22 02:50:25 +00:00
docs: add prefixTags option to configuration table
This commit is contained in:
parent
49e6c6af86
commit
9bd824ee48
1 changed files with 6 additions and 4 deletions
10
README.md
10
README.md
|
|
@ -23,15 +23,17 @@ import * as ExternalPlugin from "./.quartz/plugins";
|
|||
|
||||
ExternalPlugin.TagPage({
|
||||
numPages: 10,
|
||||
prefixTags: false,
|
||||
});
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
| ---------- | -------- | ----------- | ------------------------------------------ |
|
||||
| `sort` | `SortFn` | `undefined` | A function to sort the pages with the tag. |
|
||||
| `numPages` | `number` | `undefined` | The number of pages to show per tag page. |
|
||||
| Option | Type | Default | Description |
|
||||
| ------------ | --------- | ----------- | ------------------------------------------------------------------------------- |
|
||||
| `sort` | `SortFn` | `undefined` | A function to sort the pages with the tag. |
|
||||
| `numPages` | `number` | `undefined` | The number of pages to show per tag page. |
|
||||
| `prefixTags` | `boolean` | `false` | Whether to prefix generated tag page titles with "Tag: " (e.g. "Tag: recipes"). |
|
||||
|
||||
## Documentation
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue