mirror of
https://github.com/quartz-community/recent-notes.git
synced 2026-07-22 02:50:28 +00:00
docs: update README for v5 unified config system
This commit is contained in:
parent
54bd227daa
commit
71eca7381d
1 changed files with 17 additions and 6 deletions
23
README.md
23
README.md
|
|
@ -10,12 +10,23 @@ npx quartz plugin add github:quartz-community/recent-notes
|
|||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
// quartz.layout.ts
|
||||
import * as Plugin from "./.quartz/plugins";
|
||||
```yaml title="quartz.config.yaml"
|
||||
plugins:
|
||||
- source: github:quartz-community/recent-notes
|
||||
enabled: true
|
||||
```
|
||||
|
||||
// Add to your layout
|
||||
Plugin.RecentNotes(); // in the appropriate layout section
|
||||
For advanced use cases, you can override in TypeScript:
|
||||
|
||||
```ts title="quartz.ts (override)"
|
||||
import * as ExternalPlugin from "./.quartz/plugins";
|
||||
|
||||
ExternalPlugin.RecentNotes({
|
||||
title: "Recent Notes",
|
||||
limit: 3,
|
||||
showTags: true,
|
||||
linkToMore: false,
|
||||
});
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
|
@ -31,7 +42,7 @@ Plugin.RecentNotes(); // in the appropriate layout section
|
|||
|
||||
## Documentation
|
||||
|
||||
See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information.
|
||||
See the [Quartz documentation](https://quartz.jzhao.xyz/features/recent%20notes) for more information.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue