Need private packages and team management tools?Check out npm Teams »

summary-more

3.1.2 • Public • Published

Build Status Coverage Status

summary-more

summary-more is a tool that search for all *.md files in your project and list them in the README.md file. What summary-more specifically does is to search in the folder (current or provided one) all the *.md files and list their links one by one inside a provided section of the README.md file. This is a fast and automatic way to quickly link all the documents inside of a project in the main README.md and it is pretty useful for massive or big documented projects.

The outcome of this application is visible in the example README.md.

Requirements

  • node 10.0+
  • npm 6.0+

Installation

summary-more can be installed as a global tool:

$ npm install -g summary-more
 
$ yarn global add summary-more

or as a devDependency:

$ npm install -D summary-more
 
$ yarn add --dev summary-more

Help

 
$ summary-more --help
 
Usage: summary-more [options] <option>
 
Options:
 
-v, --version                           output the version number
-s, --docsSection [docsSection]         * section title where documentation will be listed in README.md
-b, --baseFolder [baseFolder]           base folder where README.md is located
-d, --docsFolder [docsFolder]           subfolder of the basefolder where documentation is located
-l, --headingLevel [headingLevel]       heading level of the section title within README.md
-h, --help                              output usage information
 
 
* Mandatory

Usage

$ summary-more -s 'documentation'
$ summary-more -d 'docs' -s 'Summary'
$ summary-more -b 'manual' -d 'docs' -s 'Summary'
$ summary-more -b 'manual' -d 'docs' -s 'Summary' -l 2

Install

npm i summary-more

DownloadsWeekly Downloads

67

Version

3.1.2

License

MIT

Unpacked Size

108 kB

Total Files

33

Last publish

Collaborators

  • avatar