mdSmith

mdSmith is a CLI tool that analyzes Node.js projects and automatically generates structured, professional README files.

Stop writing boilerplate documentation. Let your project describe itself.

🚀 Why mdSmith?

Most repositories suffer from one of these problems:

• No README
• Poorly structured documentation
• Outdated project info
• Missing setup instructions

mdSmith scans your project, detects your stack, analyzes dependencies, and generates a clean, organized README in seconds.

⚡ Features

• 🔍 Automatic tech stack detection
• 📁 Project structure scanning
• 📦 Dependency listing
• 🧠 Script analysis
• 🩺 Health checks
• 📝 Automated README generation
• ⚙️ Config support
• 🖥 Interactive CLI

📦 Installation

Using npx

npx mdsmith --readme

Or install globally

npm install -g mdsmith

🛠 Usage

Generate a README:

mdsmith --readme

Analyze project health:

mdsmith --analyze

Show project structure:

mdsmith --tree

List dependencies:

mdsmith --deps

🧠 How It Works

mdSmith is built with a modular architecture:

• Detectors → Identify tech stack and project characteristics
• Scanner → Recursively maps project structure
• Generators → Build formatted markdown output
• Analysis Engine → Evaluates scripts and project health
• Formatters → Clean CLI output

This separation allows the CLI to scale and evolve cleanly.

📌 Roadmap

• Multi-language support
• Template customization
• Plugin system
• Support for non-Node projects
• Configurable README sections

📄 License

MIT License