md-generator
NPM Package which bootstraps Development by creating all required .md files to meet community standards.
Last updated 11 days ago by shegsteham .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install md-generator 
SYNC missed versions from official npm registry.

md-generator

Version Coverage Status Version Version Version

CLI tool which bootstraps Development by creating "ALL" required .md files to meet "community standards".

Table of Contents

Project Overview

md-generator was created to reduce the time spent creating .md files while trying to set up projects. Hence, bootstrapping development with ALL desired md files in line with proven community standards.

Features

  • [x] provides interactive file creation
  • [x] provides default templates in all created files (which could be further customized)
  • [x] checks if the minimum community standard is met and recommends the minimum required .md files
  • [x] provides bulk removal of specified .md files
  • [x] provides bulk creation of .md files
  • [x] optional --empty argument to make created files empty if preferred so
  • [x] optional --required to create/check/list only all files needed to meet the minimum community standard

Installation

npm install md-generator or globally using npm install -g md-generator

  • you can interact with the package from the npm registry using npx md-generator [command] [options]

Usage

install globally using

  • npm : npm i -g md-generator
  • yarn : yarn add -g md-generator

Trigger md-generator using

  • md-generator [parent-options]
  • md-generator [commands] [command-options] [file names]

Parent Options:

Option Function
-V, --version Output the version number
-h, --help Output usage information

Commands:

Command Function
list [options] [File Names] List All Required/optional .md files
create [options] [File Names] Create All/specific files
check [options] [File Names] Checks codebase for the availability of All/Specific .md files
remove [options] [File Names] Remove All/specific .md files

Command-Options :

Command Option Function
-A, --all Operate on all required/optional .md files
-F, --file Operate on specific .md files
-E, --empty make added files empty
-R --required Operate on required files
-O --optional Operate on optional files

Note:

  • File Names can be with/without the file extension
  • multiples File Names should be separated with spaces ie --file "README.md CONTRIBUTING.md".

Demo

Demo Demo

Cli Command Function
md-generator --help displays help (all available command and option)
md-generator list lists all supported .md files
md-generator list --optional lists all supported optional .md files
md-generator list --required lists all required .md files to meet community standard
md-generator check checks code base for existing/missing supported .md files
md-generator check --required checks code base for existing/missing required .md files
md-generator check --optional checks code base for existing/missing optional .md files
md-generator create Interactively Generates all desired files
md-generator create --file "file1.md file2.md ..." Creates the supplied files
md-generator create --file "file1 file2 ..." --empty creates supplied files with no template
md-generator create --required Interactively create required .md files
md-generator create --optional Interactively create optional .md files
md-generator remove Interactively deletes all desired .md files
md-generator remove --file "file1 file2 ..." Interactively deletes all specified .md files

Known issues

No known issues at the moment. However, issues can be raised when such is noticed

Contributing

Feel free to contribute and kindly go through the Pull Request guide, and contributing.md file ???? Clone the repository using https://github.com/Oluwasegun-AA/md-generator.git . Make Contributions

Contributors

Thanks goes to these wonderful people (emoji key):

Adépòjù Olúwáségun
Adépòjù Olúwáségun

???? ???? ???? ⚠️

This project follows the all-contributors specification. Contributions of any kind are welcome!

License

GitHub


This File was generated by md-generator

Current Tags

  • 0.3.0                                ...           latest (11 days ago)

21 Versions

  • 0.3.0                                ...           11 days ago
  • 0.2.9                                ...           11 days ago
  • 0.2.8                                ...           6 months ago
  • 0.2.7                                ...           7 months ago
  • 0.2.6                                ...           7 months ago
  • 0.2.5                                ...           7 months ago
  • 0.2.4                                ...           7 months ago
  • 0.2.3                                ...           7 months ago
  • 0.2.2                                ...           7 months ago
  • 0.2.1                                ...           7 months ago
  • 0.2.0                                ...           7 months ago
  • 0.1.9                                ...           7 months ago
  • 0.1.8                                ...           7 months ago
  • 0.1.7                                ...           7 months ago
  • 0.1.6                                ...           7 months ago
  • 0.1.5                                ...           7 months ago
  • 0.1.4                                ...           7 months ago
  • 0.1.3                                ...           7 months ago
  • 0.1.2                                ...           7 months ago
  • 0.1.1                                ...           7 months ago
  • 0.1.0                                ...           7 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 17
Last Day 0
Last Week 0
Last Month 19
Dependencies (28)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |