{"id":20918245,"url":"https://github.com/silversonicaxel/summary-more","last_synced_at":"2025-05-13T12:31:15.289Z","repository":{"id":34320322,"uuid":"176366738","full_name":"silversonicaxel/summary-more","owner":"silversonicaxel","description":"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.","archived":false,"fork":false,"pushed_at":"2024-11-18T22:41:15.000Z","size":472,"stargazers_count":4,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-18T03:26:18.369Z","etag":null,"topics":["documentation","documentation-tool","md","readme","readme-md","summary"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silversonicaxel.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-18T20:46:38.000Z","updated_at":"2025-03-02T13:45:47.000Z","dependencies_parsed_at":"2024-06-12T11:49:52.749Z","dependency_job_id":"9e5f4a77-7eea-4b33-b11e-f2e4f5fcc2af","html_url":"https://github.com/silversonicaxel/summary-more","commit_stats":{"total_commits":121,"total_committers":2,"mean_commits":60.5,"dds":"0.016528925619834656","last_synced_commit":"a932b9e88d3d8b743f06cd5262fe99b4f2b3870d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silversonicaxel%2Fsummary-more","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silversonicaxel%2Fsummary-more/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silversonicaxel%2Fsummary-more/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silversonicaxel%2Fsummary-more/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silversonicaxel","download_url":"https://codeload.github.com/silversonicaxel/summary-more/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253942258,"owners_count":21988020,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","documentation-tool","md","readme","readme-md","summary"],"created_at":"2024-11-18T16:38:16.038Z","updated_at":"2025-05-13T12:31:14.992Z","avatar_url":"https://github.com/silversonicaxel.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Coverage Status](https://coveralls.io/repos/github/silversonicaxel/summary-more/badge.svg?branch=master)](https://coveralls.io/github/silversonicaxel/summary-more?branch=master)\n\n# summary-more\nsummary-more is a tool that search for all *.md files in your project and list them in the README.md file.\nWhat 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.\nThis 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.\n\nThe outcome of this application is visible in the example [README.md](fixtures/README.md).\n\n## Requirements\n* node 10.12+\n* npm 6.0+\n\n## Installation\nsummary-more can be installed as a global tool:\n\n```bash\n$ npm install -g summary-more\n\n$ yarn global add summary-more\n```\n\nor as a devDependency:\n\n```bash\n$ npm install -D summary-more\n\n$ yarn add --dev summary-more\n```\n\n## Help\n```bash\n\n$ summary-more --help\n\nUsage: summary-more [options] \u003coption\u003e\n\nOptions:\n\n-v, --version                           output the version number\n-s, --docsSection [docsSection]         * section title where documentation will be listed in README.md\n-b, --baseFolder [baseFolder]           base folder where README.md is located\n-d, --docsFolder [docsFolder]           subfolder of the basefolder where documentation is located\n-l, --headingLevel [headingLevel]       heading level of the section title within README.md\n-h, --help                              output usage information\n\n\n* Mandatory\n```\n\n## Usage\n\n```bash\n$ summary-more -s 'documentation'\n```\n\n```bash\n$ summary-more -d 'docs' -s 'Summary'\n```\n\n```bash\n$ summary-more -b 'manual' -d 'docs' -s 'Summary'\n```\n\n```bash\n$ summary-more -b 'manual' -d 'docs' -s 'Summary' -l 2\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilversonicaxel%2Fsummary-more","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilversonicaxel%2Fsummary-more","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilversonicaxel%2Fsummary-more/lists"}