search

AVATEAM-IT-SYSTEMHAUS / mkdocs-kroki-plugin

MkDocs plugin for Kroki-Diagrams
MIT License
42 stars 27 forks source link

Allow to render diagrams from file #12

Closed tsouvarev closed 1 year ago

tsouvarev commented 2 years ago

I want to render really big diagrams (BPMN, which is XML), so it's handy to put diagram code in separate file and link it from docs.

b-bittner commented 1 year ago

Hello @tsouvarev , thanks for your PR, I appreciate your effort and looking forward to integrate your extension. It would be helpful for the users if the is something for troubleshooting/logging, when the file does not exists. Could you please add some logging and maybe also some hint which will be rendered into to docs.

tsouvarev commented 1 year ago

Sure, that makes sense. I will look into it.

tsouvarev commented 1 year ago

@b-bittner I've added info message before reading file and error if operation didn't succeed

b-bittner commented 1 year ago

Hello @tsouvarev , sorry for the long silence, the last month were no time left for any other stuff than daily business. Thanks for your added changes, looks much better now. One more thing I would like you to add before I can merge the PR: Please add the mkdocs-parameter 'docs_dir' as base-path for the file-picking and also include this part of the path in the log message. I would guess, this would help others to find the problem when the plugin can't find the file.

tsouvarev commented 1 year ago

@b-bittner thanks for your time and valuable comment! fixed that