6 releases
0.0.5 | Jun 19, 2024 |
---|---|
0.0.4 | Jun 19, 2024 |
#314 in Text processing
168 downloads per month
9KB
193 lines
gen-mdbook-summary
Description
This is a simple tool to generate a SUMMARY.md
file for a mdBook project.
Installation and Usage
quick start:
# install the tool
cargo install gen-mdbook-summary
# create a mdbook project
mkdir my-mdbook && cd my-mdbook && mdbook init
# create a ignore file for gen-mdbook-summary
echo "**/readme.md" > mdbook.ignore
# generate a summary file
gms -d src -o src/SUMMARY.md
# serve the mdbook,and then visit http://localhost:3000
mdbook serve
for more usage, please check the help message:
gms --help
and the examples directory.
License
Dependencies
~5–14MB
~165K SLoC