search

backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
82 stars 61 forks source link

configuration options for plantuml_markdown #169

Closed hpgrahsl closed 4 months ago

hpgrahsl commented 4 months ago

Hi all,

according to the readme the plantuml_markdown extension is part of techdocs core. What's unclear to me is how I could provide configuration for this extension when running techdocs-cli to locally process some documentation?

e.g. where would I specify that I want to use a remote plantuml server to render instead of doing it locally by means of the plantuml.jar ?

Thanks for any pointers.

hpgrahsl commented 4 months ago

I eventually figured this out earlier today. The part that isn't easy to find is that the mkdocs conf needs to look as follows:

...
markdown_extensions: 
  - plantuml_markdown:
      option1: ...
      ...
      optionN: ...
...