mirror of
https://github.com/quartz-community/footer.git
synced 2026-07-22 02:50:23 +00:00
docs: update README for v5 unified config system
This commit is contained in:
parent
51fe0b7677
commit
27c9cb7400
1 changed files with 18 additions and 7 deletions
25
README.md
25
README.md
|
|
@ -10,14 +10,25 @@ npx quartz plugin add github:quartz-community/footer
|
|||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
// quartz.layout.ts
|
||||
import * as Plugin from "./.quartz/plugins";
|
||||
```yaml title="quartz.config.yaml"
|
||||
plugins:
|
||||
- source: github:quartz-community/footer
|
||||
enabled: true
|
||||
options:
|
||||
links:
|
||||
GitHub: https://github.com/jackyzha0/quartz
|
||||
Discord Community: https://discord.gg/cRFFHYye7t
|
||||
```
|
||||
|
||||
// Add to your layout
|
||||
Plugin.Footer({
|
||||
For advanced use cases, you can override in TypeScript:
|
||||
|
||||
```ts title="quartz.ts (override)"
|
||||
import * as ExternalPlugin from "./.quartz/plugins";
|
||||
|
||||
ExternalPlugin.Footer({
|
||||
links: {
|
||||
GitHub: "https://github.com/quartz-community",
|
||||
GitHub: "https://github.com/jackyzha0/quartz",
|
||||
"Discord Community": "https://discord.gg/cRFFHYye7t",
|
||||
},
|
||||
});
|
||||
```
|
||||
|
|
@ -30,7 +41,7 @@ Plugin.Footer({
|
|||
|
||||
## Documentation
|
||||
|
||||
See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information.
|
||||
See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/Footer) for more information.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue