https://github.com/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.
https://github.com/silversonicaxel/summary-more
documentation documentation-tool md readme readme-md summary
Last synced: 5 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/silversonicaxel/summary-more
- Owner: silversonicaxel
- License: mit
- Created: 2019-03-18T20:46:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T22:41:15.000Z (11 months ago)
- Last Synced: 2025-04-18T03:26:18.369Z (6 months ago)
- Topics: documentation, documentation-tool, md, readme, readme-md, summary
- Language: TypeScript
- Homepage:
- Size: 461 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://coveralls.io/github/silversonicaxel/summary-more?branch=master)
# 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](fixtures/README.md).
## Requirements
* node 10.12+
* npm 6.0+
## Installation
summary-more can be installed as a global tool:
```bash
$ npm install -g summary-more
$ yarn global add summary-more
```
or as a devDependency:
```bash
$ npm install -D summary-more
$ yarn add --dev summary-more
```
## Help
```bash
$ summary-more --help
Usage: summary-more [options]
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
```bash
$ summary-more -s 'documentation'
```
```bash
$ summary-more -d 'docs' -s 'Summary'
```
```bash
$ summary-more -b 'manual' -d 'docs' -s 'Summary'
```
```bash
$ summary-more -b 'manual' -d 'docs' -s 'Summary' -l 2
```