https://github.com/zzstoatzz/mdxify
Generate MDX API documentation from Python modules
https://github.com/zzstoatzz/mdxify
api-ref api-reference mdx mintlify python
Last synced: 13 days ago
JSON representation
Generate MDX API documentation from Python modules
- Host: GitHub
- URL: https://github.com/zzstoatzz/mdxify
- Owner: zzstoatzz
- Created: 2025-06-19T22:23:52.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2026-02-17T15:41:41.000Z (about 2 months ago)
- Last Synced: 2026-02-17T20:19:53.917Z (about 2 months ago)
- Topics: api-ref, api-reference, mdx, mintlify, python
- Language: Python
- Homepage: https://mdxify.zzstoatzz.io
- Size: 1.32 MB
- Stars: 22
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# `mdxify`
Generate API documentation from Python modules with automatic navigation and source links.
## Projects Using `mdxify`
- **[`mdxify`](https://github.com/zzstoatzz/mdxify)** — This documentation at [mdxify.zzstoatzz.io](https://mdxify.zzstoatzz.io)
- **[FastMCP](https://github.com/jlowin/fastmcp)** — API docs at [gofastmcp.com/python-sdk](https://gofastmcp.com/python-sdk)
- **[Prefect](https://github.com/PrefectHQ/prefect)** — API reference at [docs.prefect.io/v3/api-ref/python](https://docs.prefect.io/v3/api-ref/python)
## Quick Start
```bash
uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk
```
## Documentation
📚 **[View full documentation →](https://mdxify.zzstoatzz.io)**
- [Introduction](https://mdxify.zzstoatzz.io/introduction)
- [Quick Start Guide](https://mdxify.zzstoatzz.io/quickstart)
- [API Reference](https://mdxify.zzstoatzz.io/python-sdk/mdxify-cli)
## Features
- Fast AST-based parsing
- MDX output with safe escaping
- Automatic hierarchical navigation (Mintlify)
- Google-style docstrings via Griffe
- Smart filtering of private modules
## Development
See `CONTRIBUTING.md` for local setup, testing, linting, and release guidance.
> [!IMPORTANT]
> This project is not associated with the company Mintlify.