Doc Gen

🚀Doc Gen

v1.1.0

Scan repositories and turn their structure into readable Markdown, terminal trees, and analysis summaries.

Commanddoc-gen

📦Category

Documentation Tooling

🚀Quick Command

doc-gen COMMAND [OPTIONS]

---

📦

Python

3.9+

⚙️

Standard runtime

Python 3.14

📄

Output

Markdown and terminal

🏷️

Version

1.1.0

Doc Gen at a Glance

A representative Doc Gen structure workflow. The final release screenshot can be added without changing this page.

✨Features

Generate

Write a structured Markdown document to an explicit output path.

Print

Render the project tree in the terminal without writing project documentation.

Analyze

Summarize project type, directories, files, and scan characteristics.

Adapt

Use profiles or smart mode to tune depth, visibility, and collapsed directories.

ℹ️Only generate writes documentation

structure print and structure analyze are read-only. structure generate --dry-run scans and renders but does not create its output directory or file.

Quick preview

bash

doc-gen structure print .
doc-gen structure analyze .
doc-gen structure generate . --dry-run