Skip to content

Commit 68c3a00

Browse files
authored
docs: switch README to uvx usage and document Markdown support (#25)
1 parent 747d631 commit 68c3a00

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# mdxify
22

3-
Generate API documentation from Python modules with automatic navigation and source links. MDX is the default output today; Markdown support is planned.
3+
Generate API documentation from Python modules with automatic navigation and source links. MDX is the default output and Markdown is also supported via `--format md`.
44

55
## Projects Using mdxify
66

@@ -9,10 +9,12 @@ mdxify powers the API docs for:
99
- [FastMCP](https://github.com/jlowin/fastmcp) — live at https://gofastmcp.com/python-sdk
1010
- [Prefect](https://github.com/PrefectHQ/prefect) — API ref at https://docs.prefect.io/v3/api-ref/python
1111

12-
## Installation
12+
## Usage
13+
14+
Run without installing using uvx:
1315

1416
```bash
15-
pip install mdxify
17+
uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk
1618
```
1719

1820
## Quick Start
@@ -23,19 +25,19 @@ pip install mdxify
2325
Generate docs for all modules in a package:
2426

2527
```bash
26-
mdxify --all --root-module mypackage --output-dir docs/python-sdk
28+
uvx mdxify --all --root-module mypackage --output-dir docs/python-sdk
2729
```
2830

2931
Generate docs for specific modules:
3032

3133
```bash
32-
mdxify mypackage.core mypackage.utils --output-dir docs/python-sdk
34+
uvx mdxify mypackage.core mypackage.utils --output-dir docs/python-sdk
3335
```
3436

3537
Exclude internal modules:
3638

3739
```bash
38-
mdxify --all --root-module mypackage \
40+
uvx mdxify --all --root-module mypackage \
3941
--exclude mypackage.internal --exclude mypackage.tests
4042
```
4143

@@ -119,15 +121,21 @@ Add GitHub source links to functions/classes/methods:
119121

120122
```bash
121123
# Auto-detect repository from git remote
122-
mdxify --all --root-module mypackage
124+
uvx mdxify --all --root-module mypackage
123125
124126
# Or specify repository explicitly
125-
mdxify --all --root-module mypackage \
127+
uvx mdxify --all --root-module mypackage \
126128
--repo-url https://github.com/owner/repo --branch develop
127129
```
128130

129131
Customize link text via `MDXIFY_SOURCE_LINK_TEXT` if desired.
130132

133+
To generate Markdown instead of MDX, pass `--format md` (navigation updates are disabled in Markdown mode):
134+
135+
```bash
136+
uvx mdxify --all --root-module mypackage --format md --no-update-nav
137+
```
138+
131139
## Features
132140

133141
- Fast AST-based parsing (no imports)

0 commit comments

Comments
 (0)