mirror of
https://github.com/quartz-community/article-title.git
synced 2026-07-22 02:50:30 +00:00
docs: update README for v5 unified config system
This commit is contained in:
parent
9cce24df7b
commit
33cefa3492
1 changed files with 8 additions and 7 deletions
15
README.md
15
README.md
|
|
@ -10,12 +10,13 @@ npx quartz plugin add github:quartz-community/article-title
|
|||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
// quartz.layout.ts
|
||||
import * as Plugin from "./.quartz/plugins";
|
||||
|
||||
// Add to your layout
|
||||
Plugin.ArticleTitle(); // in the appropriate layout section
|
||||
```yaml title="quartz.config.yaml"
|
||||
plugins:
|
||||
- source: github:quartz-community/article-title
|
||||
enabled: true
|
||||
layout:
|
||||
position: beforeBody
|
||||
priority: 10
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
|
@ -24,7 +25,7 @@ This plugin has no configuration options.
|
|||
|
||||
## Documentation
|
||||
|
||||
See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information.
|
||||
See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/ArticleTitle) for more information.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue