https://github.com/dvogt23/book-summary

📔Book auto-summary 🦀🖤 (gitbook/mdBook)
https://github.com/dvogt23/book-summary

gitbook gitbook-summary mdbook mdbook-summary summary

Last synced: 16 days ago
JSON representation

📔Book auto-summary 🦀🖤 (gitbook/mdBook)

• Host: GitHub
• URL: https://github.com/dvogt23/book-summary
• Owner: dvogt23
• License: mit
• Created: 2019-04-09T20:03:28.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-11-07T08:32:27.000Z (about 2 years ago)
• Last Synced: 2024-11-07T20:54:43.573Z (about 1 month ago)
• Topics: gitbook, gitbook-summary, mdbook, mdbook-summary, summary
• Language: Rust
• Homepage:
• Size: 58.6 KB
• Stars: 31
• Watchers: 3
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - dvogt23/book-summary - 📔Book auto-summary 🦀🖤 (gitbook/mdBook) (others)

README

        
# book-summary

![book-summary-check build status](https://github.com/dvogt23/book-summary/workflows/check/badge.svg)

![book-summary-tests build status](https://github.com/dvogt23/book-summary/workflows/test/badge.svg)



> 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](https://github.com/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](https://github.com/dvogt23/notes)

## Installation

OS X & Linux:

```sh

cargo install book-summary

```

```sh

git clone https://github.com/dvogt23/book-summary.git

cd book-summary

make install

```

## Usage example

```sh

# create a SUMMARY.md file with custom sort in mdBook format

$ book-summary -n ./notes --sort tech personal

```

```sh

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 md/git book [default: md]

    -n, --notesdir         Notes dir where to parse all your notes from [default: ./]

    -o, --outputfile     Output file [default: SUMMARY.md]

    -s, --sort ...             Start with following chapters

    -t, --title               Title for summary [default: Summary]

```

## Contributing

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

## Authors

* **Dimitrij Vogt** - *Initial work* - [gh/dvogt23](https://github.com/dvogt23)

* **Miguel Berrio** - *Contribution* - [gh/B3RR10](https://github.com/B3RR10)

See also the list of [contributors](https://github.com/dvogt23/book-summary/contributors) who participated in this project.

## License

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