mkdocs / mkdocs-click

An MkDocs extension to generate documentation for Click command line applications
https://pypi.org/project/mkdocs-click
Apache License 2.0
109 stars 16 forks source link

Add to mkdocs wiki plugin overview #40

Closed timvink closed 1 year ago

timvink commented 3 years ago

Nice plugin!

I actually wish I'd discovered it earlier. Can I suggest you add the plugin to the overview here: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Plugins. It will help visibility :)

Perhaps useful for this plugin as well, the approach I took is using mkdocs-macros to insert the output of some_click_command --help into my mkdocs folder. Relevant code bits:

oprypin commented 1 year ago

It is there https://github.com/mkdocs/catalog#-api-documentation-building