jaivardhan-bhola/documentation-generator

A CLI Program To Generate documentation websites For Projects

documentation-generator

Table of Contents

• Description
• Installation
• Usage
• Screenshots
• About the author
• Contribution
• Support Us
• License

Description

A CLI Program To Generate documentation websites For Projects

Installation

Fork the repo

Clone the repo

navigate to the main directory

Run

npm install

Usage

Create docs directory

Create assets directort

Create media directory

Add images according to description number {1.png, 2.png,....}

Run

node index.js

Screenshots

About-the-author

Contribution

If you would like to contribute to this project reach out to me. Contact Information can be found below or by clicking on the 'Contact-Information' link provided in the Table of Contents.

Show-your-support

Give a ⭐️ star if this project helped you!

License

Copyright © 2022 Jaivardhan Bhola.
This project is MIT licensed.

---