cargo-doc-md

🤖 AI-Generated Project: Created entirely by Claude (Anthropic AI). See ATTRIBUTION.md.

A Cargo subcommand that generates markdown documentation for Rust crates and their dependencies.

Installation

cargo install cargo-doc-md

Usage

# Document current crate + all dependencies (like cargo doc)
cargo doc-md

# Document only dependencies
cargo doc-md --all-deps

# Document specific dependencies
cargo doc-md --deps tokio,axum

# Custom output directory
cargo doc-md -o docs/

Output Structure

target/doc-md/
  index.md                    # Master index
  your_crate/
    index.md                  # Crate overview
    module1.md                # One file per module
    module2.md
    sub/
      nested_module.md
  deps/
    tokio/
      index.md
      io.md
      net.md
    ...

Use Cases

Provide API documentation to LLMs as context
Read documentation in your terminal or editor
Generate offline documentation for your entire dependency tree
Navigate large codebases with multi-file output

Features

Multi-file output with one markdown file per module
Master index listing all documented crates
Breadcrumb navigation showing module hierarchy
Module summaries with item counts
Complete type signatures for all items
Automatic dependency discovery and documentation
Handles multiple versions of the same dependency
Gracefully skips dependencies that fail to build

Options

cargo doc-md [OPTIONS] [INPUT]

Options:
  -o, --output <DIR>        Output directory [default: target/doc-md]
      --all-deps            Document only dependencies (exclude current crate)
      --deps <CRATES>       Document specific dependencies (comma-separated)
      --include-private     Include private items
  -h, --help               Show help

Run cargo doc-md --help for detailed information.

Requires Rust nightly.

Development

This project uses snapshot testing to ensure output quality and consistency. Run tests with:

cargo test

When making changes to the output format, review snapshot changes with:

cargo insta review

See tests/README.md for more information about the test suite.

License

MIT or Apache-2.0

cargo-doc-md 0.7.5