source link

v0.2.14

feat: add MDXIFY_SOURCE_LINK_TEXT environment variable for customizin…

v0.2.13

Improve anchor/group support documentation and error messages

- Updated error message to show both anchor and group placeholder examples
- Enhanced README to demonstrate both anchor format (FastMCP) and group format (Prefect)
- Clarified that --anchor-name (and its alias --navigation-key) searches for both types
- All tests pass, zero breaking changes maintained

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

v0.2.12

Full Changelog: v0.2.11...v0.2.12

v0.2.11

fix: make anchor navigation search recursive to support nested tab st…

v0.2.10

What's Changed

New Features

• Added --exclude parameter to exclude specific modules from documentation generation (#3)
  • Excludes the specified module and all its submodules
  • Implements declarative behavior - removes existing MDX files for excluded modules
  • Warns when exclude patterns don't match any modules

Improvements

• Added Ruff linting to pre-commit configuration
• Removed hardcoded module exclusion patterns - only underscore-prefixed modules are excluded by default
• Improved code organization by extracting file removal logic into a helper function

Bug Fixes

• Fixed test issues with undefined variables

Usage

Exclude modules from documentation:

mdxify --all --root-module mypackage --exclude mypackage.internal --exclude mypackage.tests

Full Changelog

v0.2.9...v0.2.10

v0.2.9

What's Changed

Bug Fixes

• Support Mintlify navigation format () for finding and updating existing anchors
• Fix success/failure reporting - navigation updates now correctly report when they fail
• Escape colons in parameter and exception descriptions to prevent Markdown formatting issues

New Features

• Added --anchor-name parameter to specify which navigation anchor to update (default: 'SDK Reference')
• mdxify now updates existing navigation anchors directly on subsequent runs - no placeholder needed after initial setup

Full Changelog

v0.2.8...v0.2.9

v0.2.8

What's Changed

Features

• Nested navigation groups now show simple names instead of fully qualified paths
  • For example, under fastmcp.client, the auth subgroup is just "auth" not "fastmcp.client.auth"
  • This avoids redundant path information and makes the navigation cleaner
• Navigation entries are now sorted consistently to minimize diffs in version control
  • Plain pages appear first, followed by groups
  • All entries are sorted alphabetically within their category

Testing

• Added tests for navigation sorting behavior
• Added tests for nested group naming conventions
• Updated existing tests to match new behavior

Notes

• Top-level groups still use fully qualified names (e.g., fastmcp.client)
• Only nested groups use simple names to avoid redundancy
• Groups in Mintlify are collapsible by default in the UI

Full Changelog: v0.2.7...v0.2.8

v0.2.7

What's Changed

Features

• Changed default output path from docs/api to docs/python-sdk to avoid conflicts with documentation frameworks like Mintlify

Testing

• Added comprehensive test coverage for CLI functionality
• Added end-to-end tests to verify the complete workflow
• Added tests for navigation path calculation with custom output directories

Notes

• No breaking changes - users can still use --output-dir to specify any path
• The path prefix in navigation entries is automatically calculated based on the output directory location relative to docs.json

Full Changelog: v0.2.6...v0.2.7

v0.2.6

What's Changed

• fix: restore correct hierarchical navigation with all module files by @zzstoatzz in b1daf4a

Bug Fixes

• Navigation now includes ALL module files in their groups, not just __init__ files
• Fixed critical issue where only parent module documentation was being added to navigation
• Groups now properly contain all their submodule files (e.g., cli group contains cli-claude, cli-cli, cli-run, etc.)
• Restored the correct navigation behavior from earlier versions

Full Changelog: v0.2.5...v0.2.6

v0.2.5

What's Changed

• fix: restore proper hierarchical navigation structure by @zzstoatzz in e9d9fbc

Bug Fixes

• Navigation now creates proper groups with dropdowns for modules with submodules
• Fixed issue where navigation was showing flat init entries instead of hierarchical groups
• Groups now properly contain their submodules as they did in v0.2.0
• Skip common root package to avoid unnecessary nesting

Full Changelog: v0.2.4...v0.2.5