/mdoctor

Your markdown doctor on the CLI

Primary LanguageJavaScriptApache License 2.0Apache-2.0

MDoctor

Your CLI Markdown 👨‍⚕️ Doctor

Code style: prettier Npm Downloads Version

Getting Started

MDoctor developed for the developers who want to create a markdown file with a template. It is a simple CLI tool that creates a markdown file with a template.

If you have NodeJS environment you can basically install MDoctor with single npm install command.

npm install mdoctor --global

Creating README is so easy

Just use mdoctor create command and answer the questions. That's it!

mdoctor create

Cli Commands

All commands are prefixed with mdoctor or markdown-doctor.

    create: Creates a README.md file for your project
    help: Shows the help menu
    version: Shows the app version

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details