Skip to content

Commit

Permalink
docs: add UserAgent description
Browse files Browse the repository at this point in the history
Merge pull request AVATEAM-IT-SYSTEMHAUS#56 from AVATEAM-IT-SYSTEMHAUS/54-document-useragent-config-option
  • Loading branch information
oniboni authored May 9, 2024
2 parents 22a66cb + d996139 commit ea93ba8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ plugins:
| `EnableMermaid` | Enable Mermaid, default: `true` |
| `EnableDiagramsnet` | Enable diagrams.net (draw.io), default: `false` |
| `HttpMethod` | Http method to use (`GET` or `POST`), default: `GET`<br>__Note:__ On `POST` the retrieved images are stored next to the including page in the build directory |
| `UserAgent` | User agent for requests to the kroki server, default: `kroki.plugin/0.7.1` |
| `FileTypes` | File types you want to use, default: `[svg]`<br>__Note:__ not all file formats work with all diagram types <https://kroki.io/#support> |
| `FileTypeOverrides` | Overrides for specific diagram types to set the desired file type, default: empty |
| `FailFast` | Errors are raised as plugin errors, default: `false` |
Expand Down
2 changes: 1 addition & 1 deletion kroki/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class KrokiPluginConfig(MkDocsBaseConfig):
EnableMermaid = MkDocsConfigType(bool, default=True)
EnableDiagramsnet = MkDocsConfigType(bool, default=False)
HttpMethod = MkDocsConfigChoice(choices=["GET", "POST"], default="GET")
UserAgent = MkDocsConfigType(str, default=f"{__name__}/0.6.1")
UserAgent = MkDocsConfigType(str, default=f"{__name__}/0.7.1")
FencePrefix = MkDocsConfigType(str, default="kroki-")
FileTypes = MkDocsConfigType(list, default=["svg"])
FileTypeOverrides = MkDocsConfigType(dict, default={})
Expand Down

0 comments on commit ea93ba8

Please sign in to comment.