j/cyberware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix(docs): correct ExplicitPublish as filters instead of transformers (#953)

Browse source
This commit is contained in:
sventec 2024-03-03 19:40:42 -05:00 committed by GitHub
parent 2a7e61ae2a
commit bd05950c2d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/configuration.md
View file

@ -73,10 +73,10 @@ You can customize the behaviour of Quartz by adding, removing and reordering plu
> [!note] > [!note]
> Each node is modified by every transformer _in order_. Some transformers are position sensitive, so you may need to pay particular attention to whether they need to come before or after certain other plugins. > Each node is modified by every transformer _in order_. Some transformers are position sensitive, so you may need to pay particular attention to whether they need to come before or after certain other plugins.
You should take care to add the plugin to the right entry corresponding to its plugin type. For example, to add the [[ExplicitPublish]] plugin (a [[tags/plugin/transformer|Transformer]], you would add the following line: You should take care to add the plugin to the right entry corresponding to its plugin type. For example, to add the [[ExplicitPublish]] plugin (a [[tags/plugin/filter|Filter]]), you would add the following line:
```ts title="quartz.config.ts" ```ts title="quartz.config.ts"
transformers: [ filters: [
... ...
Plugin.ExplicitPublish(), Plugin.ExplicitPublish(),
... ...

2
docs/plugins/ExplicitPublish.md
View file

@ -13,6 +13,6 @@ This plugin has no configuration options.
## API ## API
- Category: Emitter - Category: Filter
- Function name: `Plugin.ExplicitPublish()`. - Function name: `Plugin.ExplicitPublish()`.
- Source: [`quartz/plugins/filters/explicit.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/explicit.ts). - Source: [`quartz/plugins/filters/explicit.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/explicit.ts).