-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
28 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,4 @@ | ||
--- | ||
order: -1 | ||
--- | ||
# Plugins | ||
|
||
Djockey has a plugin API that allows arbitrary transforms on documents. | ||
|
||
You can use plugins by specifying a `plugins`{.language-yaml} array in your `djockey.config`{.language-sh}: | ||
|
||
```yaml | ||
plugins: | ||
- myCustomPlugin.js | ||
- plugin-from-package | ||
``` | ||
|
||
## How plugins work | ||
|
||
There is a "read" pass and a "write" pass. If a plugin creates new content that should be processed in turn by other plugins, you can configure Djockey to run more than one set of passes. | ||
|
||
```mermaid | ||
flowchart LR | ||
Parse(Read documents) --> Read(Read pass) | ||
Read --> Write(Write pass) | ||
Write -->|If configured| Read | ||
Write --> Output | ||
``` | ||
title: "Plugins" | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
order: 0 | ||
--- | ||
# Using plugins | ||
|
||
Djockey has a plugin API that allows arbitrary transforms on documents. | ||
|
||
You can use plugins by specifying a `plugins`{.language-yaml} array in your `djockey.config`{.language-sh}: | ||
|
||
```yaml | ||
plugins: | ||
- myCustomPlugin.js | ||
- plugin-from-package | ||
``` | ||
|
||
## Extra passes | ||
|
||
There is a "read" pass and a "write" pass. If a plugin creates new content that should be processed in turn by other plugins, you can configure Djockey to run more than one set of passes. | ||
|
||
```mermaid | ||
flowchart LR | ||
Parse(Read documents) --> Read(Read pass) | ||
Read --> Write(Write pass) | ||
Write -->|If configured| Read | ||
Write --> Output | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters