{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"},{"label":"Documentation","url":"https://skillfed.io/packages/category/software-development-documentation"},{"label":"Markdown","url":"https://skillfed.io/packages/category/text-processing-markup-markdown"}],"enrichment":{"capability":"Generates API documentation for Click command-line applications and embeds it into MkDocs sites as a Markdown extension.","skillfed_tags":["cli-documentation","mkdocs-plugin","click-integration"],"use_cases":["Auto-generate a CLI reference page for a Click application by pointing mkdocs-click at the root command group","Embed command documentation within a larger MkDocs site without duplicating help text","Maintain up-to-date command reference docs that stay synchronized with code changes automatically","Document nested subcommands with customizable header levels to fit your documentation structure","Display command options in either plain or table format depending on your documentation style"],"what_it_does":"mkdocs-click is an MkDocs extension that introspects Click command-line applications and automatically generates formatted documentation for them. You point it at a Click command or group, and it produces Markdown with command descriptions, options, arguments, and subcommands\u2014all embedded directly into your MkDocs site during the build. It handles nested commands, allows you to customize header depth and styling, and can optionally show full command paths and hidden commands.\n\nThe package is typically used when you have a Click CLI tool and want to keep its documentation in sync with the code without manual maintenance. Instead of writing command reference docs by hand, you add a simple block to your Markdown that references the CLI module, and the extension generates the documentation automatically. It supports both simple flat commands and complex hierarchical command groups.","worth_installing":"Yes, if you use Click for CLI tools and MkDocs for documentation. Low install friction, permissive license, and no known vulnerabilities make it a safe choice. The aging maintenance status (494 days since last release) is a minor concern but not a blocker\u2014the package is stable, the repository is not archived, and recent commits show ongoing activity. Install it when you want to eliminate manual CLI documentation maintenance."},"id":"mkdocs-click","links":{"html":"https://skillfed.io/packages/mkdocs-click","md":"https://skillfed.io/packages/mkdocs-click.md","pypi":"https://pypi.org/project/mkdocs-click/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-04-07","license_spdx":"Apache-2.0","license_treatment":"permissive","name":"mkdocs-click","python_support":"supports_current","summary":"An MkDocs extension to generate documentation for Click command line applications"},"popularity":{"monthly_downloads":1217070,"position":4207,"tier":"top_5000"},"security":{"n_vulnerabilities":0},"version":"0.9.0"}