mirror of
https://github.com/quartz-community/alias-redirects.git
synced 2026-07-22 02:50:31 +00:00
docs: update README for v5 unified config system
This commit is contained in:
parent
ad08b64178
commit
efb7a5af5b
1 changed files with 5 additions and 10 deletions
15
README.md
15
README.md
|
|
@ -10,15 +10,10 @@ npx quartz plugin add github:quartz-community/alias-redirects
|
|||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
// quartz.config.ts
|
||||
import * as ExternalPlugin from "./.quartz/plugins";
|
||||
|
||||
const config: QuartzConfig = {
|
||||
plugins: {
|
||||
emitters: [ExternalPlugin.AliasRedirects()],
|
||||
},
|
||||
};
|
||||
```yaml title="quartz.config.yaml"
|
||||
plugins:
|
||||
- source: github:quartz-community/alias-redirects
|
||||
enabled: true
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
|
@ -27,7 +22,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/AliasRedirects) for more information.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue