Skip to content

Commit

Permalink
fix(docs): correct ExplicitPublish as filters instead of transformers…
Browse files Browse the repository at this point in the history
… (#953)
  • Loading branch information
sventec committed Mar 4, 2024
1 parent 2a7e61a commit bd05950
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,10 @@ You can customize the behaviour of Quartz by adding, removing and reordering plu
> [!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.
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"
transformers: [
filters: [
...
Plugin.ExplicitPublish(),
...
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/ExplicitPublish.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ This plugin has no configuration options.

## API

- Category: Emitter
- Category: Filter
- Function name: `Plugin.ExplicitPublish()`.
- Source: [`quartz/plugins/filters/explicit.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/filters/explicit.ts).

0 comments on commit bd05950

Please sign in to comment.