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:
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]
```</p>
<h2>Contributing</h2>
<p>Feel free to open a pull request or an issue to contribute to this project.</p>
<h2>Authors</h2>
<ul>
<li><strong>Dimitrij Vogt</strong> - <em>Initial work</em> - <a href="https://github.com/dvogt23">gh/dvogt23</a></li>
<li><strong>Miguel Berrio</strong> - <em>Contribution</em> - <a href="https://github.com/B3RR10">gh/B3RR10</a></li>
</ul>
<p>See also the list of <a href="https://github.com/dvogt23/book-summary/contributors">contributors</a> who participated in this project.</p>
<h2>License</h2>
<p>This project is licensed under the MIT License - see the <a href="LICENSE.md">LICENSE.md</a> file for details.</p>
</body></html>