Skip to content

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.3.0] - 2026-04-22

Added

  • Optional dependency extra [zensical] to install Zensical alongside this package.

Changed

  • Breaking: MkDocs is no longer a default dependency. Install mkdocs-typer2[mkdocs] (or add MkDocs separately) to use the mkdocs-typer2 MkDocs plugin entry point.
  • Declared Python-Markdown (markdown on PyPI) as a direct runtime dependency so the Typer directive works without MkDocs installed.
  • MkdocsTyper is loaded lazily from mkdocs_typer2 so import mkdocs_typer2 succeeds when only the Markdown extension is needed.

Removed

  • Debug print from the Markdown block processor.

[0.2.1] - 2026-04-02

Changed

  • Constrained the MkDocs dependency to >=1.6.1,<2 (runtime and dev) so installs stay on the 1.x line until this plugin is validated against MkDocs 2.0.

[0.2.0] - 2026-01-14

Added

  • Added engine option (global + block-level) to select legacy vs native rendering.
  • Added Click-based native renderer with list/table output based on pretty.

Changed

  • Deprecated legacy markdown-parsing pretty implementation in favor of native engine.
  • Increased test coverage to 99% with new engine and CLI subcommand tests.

[0.1.8] - 2026-01-13

Fixed

  • Standardized subcommand headings in markdown output for consistency
  • Changed headings from "Sub Commands" to "Subcommands" in generated documentation
  • Adjusted hierarchy of nested subcommand headings for improved clarity and uniformity

[0.1.7] - 2026-01-13

Fixed

  • Fixed issue where nested subcommands (sub-app commands added via add_typer()) were not being properly parsed and rendered in the generated CLI documentation when using pretty=True
  • Nested subcommands are now correctly detected and rendered with proper hierarchy in the generated documentation

Changed

  • Refactored CLI code structure by moving CLI modules into a cli/ package for better organization
  • Updated entry points in pyproject.toml to reflect the new CLI module path
  • Enhanced markdown parsing to support level 3 headings (###) for nested subcommands in addition to level 2 headings (##) for subcommands

[0.1.6] - 2025-09-01

Fixed

  • Fixed issue where line breaks in help text weren't preserved when using pretty formatting option
  • Line breaks in CLI help messages and docstrings are now properly rendered in the generated documentation

[0.1.4] - 2025-03-15

Added

  • Added support for Python 3.13
  • Added per-block configuration for pretty option in documentation directives
  • Added justfile for common development tasks
  • Added docs/cli-pretty.md example for pretty-formatted CLI documentation
  • Added docs/changelog.md that includes the project's CHANGELOG

Changed

  • Enhanced documentation with more detailed usage instructions and examples
  • Updated navigation structure in mkdocs.yaml
  • Improved TyperProcessor to support overriding global pretty setting at the block level

[0.1.3] - 2025-03-09

Fixed

  • Fixed issue where docstrings weren't displayed in the generated documentation when pretty option was enabled
  • Command names are now wrapped in backticks () when usingpretty` option
  • Show help and docstring(s) in generated docs when pretty is enabled

[0.1.2] - 2025-03-05

Added

  • Added Pydantic as a dependency

Changed

  • Updated logo and branding colors
  • Added new logo variants in SVG and PNG formats

[0.1.1] - 2024-10-25

Added

  • Pretty output formatting option for CLI documentation
    • Support for table-based documentation layout
  • Automatic command parsing and documentation generation
  • Integration with Typer's built-in documentation system

Changed

  • Improved documentation rendering with markdown tables
  • Enhanced support for command arguments and options display

Fixed

  • Proper handling of optional and required parameters
  • Correct parsing of default values in CLI options

[0.1.0] - 2024-10-24

Added

  • Initial release of mkdocs-typer2
  • Basic MkDocs plugin functionality
  • Support for Typer CLI documentation generation
  • Integration with MkDocs Material theme
  • GitHub Actions for testing and deployment
  • Basic test coverage