quartz-community/content-page
1
0
Fork 0
mirror of https://github.com/quartz-community/content-page.git synced 2026-07-22 02:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README for v5 unified config system

Browse source
This commit is contained in:
saberzero1 2026-02-25 16:07:03 +01:00
parent 1fd0c11b96
commit 7d9a7549e4
No known key found for this signature in database
1 changed files with 5 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -10,28 +10,10 @@ npx quartz plugin add github:quartz-community/content-page
## Usage
```ts
// quartz.config.ts
import * as ExternalPlugin from "./.quartz/plugins";
const config: QuartzConfig = {
plugins: {
pageTypes: [ExternalPlugin.ContentPage()],
},
};
```
```ts
// quartz.layout.ts
export const layout = {
byPageType: {
content: {
beforeBody: [...],
left: [...],
right: [...],
},
},
}
```yaml title="quartz.config.yaml"
plugins:
- source: github:quartz-community/content-page
enabled: true
```
## Configuration
@ -40,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/ContentPage) for more information.
## License