#gitbook #mdbook #summary

app book-summary

Create automatically a summary file for gitbook/mdbook

3 unstable releases

0.2.1 Oct 12, 2022
0.2.0 Oct 30, 2019
0.1.0 Oct 28, 2019

#4 in #gitbook

Download history 14/week @ 2023-06-06 3/week @ 2023-06-13 17/week @ 2023-06-20 20/week @ 2023-06-27 71/week @ 2023-07-04 28/week @ 2023-07-11 62/week @ 2023-07-18 10/week @ 2023-07-25 51/week @ 2023-08-01 52/week @ 2023-08-08 14/week @ 2023-08-15 9/week @ 2023-08-22 35/week @ 2023-08-29 35/week @ 2023-09-05 39/week @ 2023-09-12 52/week @ 2023-09-19

164 downloads per month

MIT license

588 lines


book-summary-check build status book-summary-tests build status crates.io

Automatically creates a SUMMARY.md file for your book (mdbook/gitbook)

Similar to the npm version of the auto-summary tool gh/imfly/gitbook-summary, here is a rust version.

My 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


OS X & Linux:

cargo install book-summary
git clone https://github.com/dvogt23/book-summary.git
cd book-summary
make install

Usage example

# create a SUMMARY.md file with custom sort in mdBook format
$ book-summary -n ./notes --sort tech personal
    book-summary [FLAGS] [OPTIONS]

    -d, --debug        Activate debug mode
    -h, --help         Prints help information
    -m, --mdheader     Title from md file header?
    -V, --version      Prints version information
    -v, --verbose      Verbose mode (-v, -vv, -vvv)
    -y, --overwrite    Overwrite existing SUMMARY.md file

    -f, --format <format>            Format md/git book [default: md]
    -n, --notesdir <notesdir>        Notes dir where to parse all your notes from [default: ./]
    -o, --outputfile <outputfile>    Output file [default: SUMMARY.md]
    -s, --sort <sort>...             Start with following chapters
    -t, --title <title>              Title for summary [default: Summary]


Feel free to open a pull request or an issue to contribute to this project.


See also the list of contributors who participated in this project.


This project is licensed under the MIT License - see the LICENSE.md file for details.


~119K SLoC