md-scaffold
v1.2.0
Published
A micro-app to scaffold project documentation.
Readme
MD-Scaffold
A simple, vanilla Node.js CLI tool to quickly generate well-formatted documentation for your projects.
New Features
- Project Auto-Detection: Automatically reads
package.jsonto pre-fill project details. - Table of Contents: Automatically generates a linked ToC for your README.
- Live Preview: Offers to open generated files instantly in your default viewer.
- Input Validation: Ensures required fields aren't left empty.
- Configurable Templates: Customize the output by editing files in
templates/. - Multiple File Support: Generate both
README.mdandCONTRIBUTING.md.
Installation
Clone this repo and you're ready to go. No dependencies required!
Usage
Run node index.js in your terminal and follow the interactive prompts.
Author
FlyingAnt
License
This project is licensed under the MIT License.
