CLIDocMaster

CLIDocMaster is a command-line interface (CLI) application written in Node.js that automates the process of generating documentation for your CLI applications.

<p dir="auto"><a href="https://github.com/sindresorhus/awesome"><img src="https://camo.githubusercontent.com/abb97269de2982c379cbc128bba93ba724d8822bfbe082737772bd4feb59cb54/68747470733a2f2f63646e2e7261776769742e636f6d2f73696e647265736f726875732f617765736f6d652f643733303566333864323966656437386661383536353265336136336531353464643865383832392f6d656469612f62616467652e737667" alt="Awesome" data-canonical-src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" style="max-width: 100%;"></a> <a href="https://github.com/chetanraj/awesome-github-badges"><img src="https://camo.githubusercontent.com/ff817852f0d676a36eaa3108d380e0052e689d9e0bc3eb42818fb21008708420/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d616465253230576974682d4c6f76652d6f72616e67652e737667" alt="Made With Love" data-canonical-src="https://img.shields.io/badge/Made%20With-Love-orange.svg" style="max-width: 100%;"></a></p>

Table of Contents

• Features
• preview
• Prerequisites
• usage
• Installation
• Contributing
• Contact
• License

Features

• Command-Line Interface
• Automatic Documentation Generation
• Markdown Support

Preview

<img src='https://github.com/Silent-Watcher/CLIDocMaster/blob/master/demo.gif'>

Prerequisites

In order to run this project, you will need to have the following installed on your computer:

• nodejs
• yarn | npm

usage

To start the app, run the following command:

  npx cli-doc-master

Installation

To install the application, follow these steps:

1. Clone the repository to your local machine:

git clone https://github.com/Silent-Watcher/CLIDocMaster

2. Navigate to the project directory in your terminal.

  cd CLIDocMaster

3. Run yarn to install the necessary packages.

  yarn

Contributing

Contributions to this project are welcome. If you encounter any issues or have suggestions for improvement, please open an issue on the GitHub repository.

Before contributing, please review the contribution guidelines.

Contact

For additional information or inquiries, you can reach out to the project maintainer:

• Name: Silent-Watcher
• Email: alitabatabaee20@mail.com

Feel free to contact the maintainer for any questions or feedback regarding the project.

License

MIT

This project is licensed under the MIT License. You are free to modify, distribute, and use the code for personal and commercial purposes. See the LICENSE file for details.

Sponsor ❤

If you like this project, please give it a star ⭐ and/or consider buying me a coffee(s). Every donation is appreciated.

<a href="https://www.coffeete.ir/silentwatcher" rel="nofollow"> <img width="120px" src="https://camo.githubusercontent.com/ab6dddafd2bdfc2a0e66b6f4eae6f508a308c085a3093bea8b1a143ac909f14a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4275795f4d655f415f436f666665652d4646444430303f7374796c653d666f722d7468652d6261646765266c6f676f3d6275792d6d652d612d636f66666565266c6f676f436f6c6f723d626c61636b" data-canonical-src="https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&amp;logo=buy-me-a-coffee&amp;logoColor=black" style="max-width: 100%;"> </a>

<a target="_blank" rel="noopener noreferrer nofollow" href="https://camo.githubusercontent.com/6038c8f1fd8f60de75477470e5a87210e9256202e01dfba9986446304a0f0254/68747470733a2f2f63617073756c652d72656e6465722e76657263656c2e6170702f6170693f747970653d776176696e6726636f6c6f723d6772616469656e74266865696768743d36302673656374696f6e3d666f6f746572"><img src="https://camo.githubusercontent.com/6038c8f1fd8f60de75477470e5a87210e9256202e01dfba9986446304a0f0254/68747470733a2f2f63617073756c652d72656e6465722e76657263656c2e6170702f6170693f747970653d776176696e6726636f6c6f723d6772616469656e74266865696768743d36302673656374696f6e3d666f6f746572" data-canonical-src="https://capsule-render.vercel.app/api?type=waving&amp;color=gradient&amp;height=60&amp;section=footer" style="max-width: 100%;"></a>