{"id":13929636,"url":"https://github.com/dvogt23/book-summary","last_synced_at":"2025-07-19T11:32:36.589Z","repository":{"id":35503994,"uuid":"180440766","full_name":"dvogt23/book-summary","owner":"dvogt23","description":"📔Book auto-summary 🦀🖤 (gitbook/mdBook)","archived":false,"fork":false,"pushed_at":"2022-11-07T08:32:27.000Z","size":60,"stargazers_count":31,"open_issues_count":4,"forks_count":13,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-07T20:54:43.573Z","etag":null,"topics":["gitbook","gitbook-summary","mdbook","mdbook-summary","summary"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/dvogt23.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-09T20:03:28.000Z","updated_at":"2024-10-14T11:14:02.000Z","dependencies_parsed_at":"2023-01-15T22:21:06.324Z","dependency_job_id":null,"html_url":"https://github.com/dvogt23/book-summary","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvogt23%2Fbook-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvogt23%2Fbook-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvogt23%2Fbook-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dvogt23%2Fbook-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dvogt23","download_url":"https://codeload.github.com/dvogt23/book-summary/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226597776,"owners_count":17657210,"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":["gitbook","gitbook-summary","mdbook","mdbook-summary","summary"],"created_at":"2024-08-07T18:02:27.552Z","updated_at":"2024-11-26T18:31:00.308Z","avatar_url":"https://github.com/dvogt23.png","language":"Rust","funding_links":[],"categories":["others"],"sub_categories":[],"readme":"# book-summary\n\n![book-summary-check build status](https://github.com/dvogt23/book-summary/workflows/check/badge.svg)\n![book-summary-tests build status](https://github.com/dvogt23/book-summary/workflows/test/badge.svg)\n\u003ca href=\"https://crates.io/crates/book-summary\"\n    \u003e\u003cimg src=\"https://badgen.net/crates/v/book-summary\" alt=\"crates.io\"\n  /\u003e\u003c/a\u003e\n\n\u003e Automatically creates a SUMMARY.md file for your book (`mdbook/gitbook`)\n\nSimilar to the `npm` version of the auto-summary tool [gh/imfly/gitbook-summary](https://github.com/imfly/gitbook-summary), here is a `rust` version.\n\nMy initial intention is to get the chapters sorted without having to rename the chapter folders with a prefix number. The `-s` option takes the name of the chapters wich should come first. I use it in my personal notes repository: [notes](https://github.com/dvogt23/notes)\n\n## Installation\n\nOS X \u0026 Linux:\n\n```sh\ncargo install book-summary\n```\n\n```sh\ngit clone https://github.com/dvogt23/book-summary.git\ncd book-summary\nmake install\n```\n\n## Usage example\n\n```sh\n# create a SUMMARY.md file with custom sort in mdBook format\n$ book-summary -n ./notes --sort tech personal\n```\n\n```sh\nUSAGE:\n    book-summary [FLAGS] [OPTIONS]\n\nFLAGS:\n    -d, --debug        Activate debug mode\n    -h, --help         Prints help information\n    -m, --mdheader     Title from md file header?\n    -V, --version      Prints version information\n    -v, --verbose      Verbose mode (-v, -vv, -vvv)\n    -y, --overwrite    Overwrite existing SUMMARY.md file\n\nOPTIONS:\n    -f, --format \u003cformat\u003e            Format md/git book [default: md]\n    -n, --notesdir \u003cnotesdir\u003e        Notes dir where to parse all your notes from [default: ./]\n    -o, --outputfile \u003coutputfile\u003e    Output file [default: SUMMARY.md]\n    -s, --sort \u003csort\u003e...             Start with following chapters\n    -t, --title \u003ctitle\u003e              Title for summary [default: Summary]\n```\n\n## Contributing\n\nFeel free to open a pull request or an issue to contribute to this project.\n\n## Authors\n\n* **Dimitrij Vogt** - *Initial work* - [gh/dvogt23](https://github.com/dvogt23)\n* **Miguel Berrio** - *Contribution* - [gh/B3RR10](https://github.com/B3RR10)\n\nSee also the list of [contributors](https://github.com/dvogt23/book-summary/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdvogt23%2Fbook-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdvogt23%2Fbook-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdvogt23%2Fbook-summary/lists"}