{"repo":"mkdocs/mkdocs-click","free":true,"listed":false,"github":"https://github.com/mkdocs/mkdocs-click","clone":"git clone https://github.com/mkdocs/mkdocs-click.git","description":"An MkDocs extension to generate documentation for Click command line applications","language":"Python","stars":149,"topics":["mkdocs","command-line","extension","mkdocs-click"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"mkdocs-click An MkDocs extension to generate documentation for Click command line applications. Originally developed by Datadog. Installation Install from PyPI: Quickstart Add mkdocs-click to Markdown extensions in your mkdocs.yml configuration: Add a CLI application, e.g.: Add a mkdocs-click block in your Markdown: Start the docs server: Tada! 💫 Usage Documenting commands To add documentation for a command, add a mkdocs-click block where the documentation should be inserted. Example: For all available options, see the Block syntax. Multi-command support When pointed at a group (or any other multi-command), mkdocs-click will also generate documentation for sub-commands. This allows you to generate documentation for an entire CLI application by pointing mkdocs-click at the root command. Tweaking header levels By default, mkdocs-click generates Markdown headers starting at for the root command section. This is generally what you want when the documentation should fill the entire page. If you are inserting documentation within other Markdown content, you can set the :depth: option to tweak the initial header level. Note that this applies even if you are just adding a heading. By default it is set to 0 , i.e. headers start at . If set to 1 , headers will start at , and so on. Note that if you insert your own first level heading and leave depth at its default value of 0, the page will have multiple tags, which is not compatible with themes that generate page-internal menus such a","default_branch":null,"files":null,"tree":[],"storefront":"/r/mkdocs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/mkdocs/mkdocs-click/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}