silversonicaxel / summary-more

summary-more is a documentation-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.

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.12+
• 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

summary-more's Issues

Manage documents with filenames containing spaces

Insert around the created/updated summary section an "autogenerated" comment

Above and under the new section, create a comment that assert that this is an auto generated section in order to discourage other project users to update it by hand.

Target file can be custom, not simply README.md

Another configuration parameter can be the position of the section, like top, bottom or number

Ordering files and overview of steps

Hi @silversonicaxel,

Thank you for this awesome package! It made the documentation in our team work like a breeze.

I have an overview.md in a folder called releases. The releases folder also contains other files, but the overview.md should be seen as the first one to open.

I now named the overview.md as _overview.md so it shows up on the top.

Any ideas on how to improve this? No rush, it's a minor issue for us.

Use (sub)folders as part of the listed document name in the summary section