book-summary

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

Installation

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

USAGE:
    book-summary [FLAGS] [OPTIONS]

FLAGS:
    -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

OPTIONS:
    -f, --format <format>            Format md/git book [default: md]
    -k, --marker <marker>            Only update content between marker comments
    -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]

Partial Updates with Markers

Use --marker / -k to partially update a SUMMARY.md file. This keeps static sections (like a preamble or final words) intact while only regenerating the auto-generated content.

First run - creates SUMMARY.md with marker comments:

book-summary -k auto

Subsequent runs - only updates content between markers:

book-summary -k auto

Example:

Given a SUMMARY.md:

# Summary

# Preamble
- other items

<!-- book-summary-start-auto -->
# Automatic recollection

<!-- book-summary-end-auto -->

# Final words

Running book-summary -k auto will only regenerate the content between the marker comments.

mdBook Preprocessor

If you need mdbook preprocessor functionality (generating SUMMARY.md as part of the mdbook build), see mdbook-auto-gen-summary mentioned in issue #24.

Contributing

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

Authors

• Dimitrij Vogt - Initial work - gh/dvogt23
• Miguel Berrio - Contribution - gh/B3RR10

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

License

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