Create docs with a simple command
This simple CLI helps you to bootstrap a nice readme and licenses from the scratch.
This readme was bootstrapped with create-md!
Why did I make this?
Creating nice readmes, license and other docs for applications can be really boring, but it is important to make your project more understandable. In order to make this task easier, I create this CLI to automate the process of bootstrapping my readme and some other docs like licenses and issues templates.
- npm or yarn
There is no need to install the package. With modern versions of yarn and npm there is no need to install the package. You can run it directly with
yarn create and
If you use yarn:
yarn create md
If you prefer npm:
npm init md
yarn create md license
npm init md license
Hint: A well filled package.json helps the CLI to infer some default answers. Look an example below:
Call the CLI using
yarn create or
npm init. The create-md CLI take only one argument (template) and some options. If it is called with no argument, the default template will be used (readme). See below the list of available templates:
- readme (default)
- license (MIT license)
The table below describes the options available currently.
|Flag||What is it?||What does it do?||Default value|
||File extension||Set the extension of the output file to the given value.||
||File name||Set the name of the output file to the given value.||template's name|
yarn createcan be replaced by
npm initin the examples.
Creating a readme named foo inside a folder named docs:
yarn create md readme --name=docs/foo
Creating a license named with no extension
yarn create md license --ext=
- Generate md files
- Answer inference
- Modular templates
- Refactor the basecode
- Write tests
- Feature: ask if user want to overwrite files if already exists
- Feature: take custom templates as argument
- Create more templates
- Feature: flag
--allmust create default markdowns (readme, license, issues etc.) in batch
Contributions, issues and feature requests are welcome!
⭐️Star the project
🐛Find and report issues
📥Submit PRs to help solve issues or add features
Feel free to check issues page. You can also take a look at the contributing guide.
Copyright © 2020 Lucas Miranda This project is MIT licensed.