Agmd NPM | npm.io

Auto-Generate-MD (agmd)

Auto-Generate-MD is a versatile tool designed to enhance front-end code management. Perfect for developers and teams looking to streamline their documentation process, it offers a range of features from automatic markdown generation to detailed project analysis.

简体中文 | English

🚀 Features

Automatic Markdown Generation: Enter agmd in any directory to create a markdown file summarizing its contents.
Code and File Analysis: Provides statistics on code volume and file types within your project.
Path Conversion: Converts absolute paths to relative for easier file navigation in VS Code.
Route Marking: Classifies the project based on routes, aiding in project segmentation.
Interface-Friendly: Offers a GUI for command operations, eliminating the need to memorize commands.
Comprehensive Structure Tree: Generates a JSON tree representing the entire project structure.
TypeScript Support: Written in TypeScript with 85% of the code covered by test cases.

Interface Preview

Use Cases

Installation and Usage

Global Installation:
- Install globally using npm i agmd -g.
- Run agmd in the desired directory to generate markdown files.
Dependency Installation:
- Install as a dev dependency with npm i agmd -D.
- Configure in package.json for automatic documentation updates.

Command Descriptions

Help
Generate structure tree document
Convert to relative paths
Complete file suffix
Rename files and folders to KebabCase
Mark and categorize files
Advanced Use
Classify files using classify.js in the src directory.
Access getFileNodes() and getMd() for custom documentation.

Command Line Arguments

agmd -h for help.
--ignore to exclude files or folders.
--include to specify file types for inclusion.
Development and Contribution
This project includes 26 tests for easy expansion and modification. Contributions and PRs are welcome.