gen-mdbook-summary
| Crates.io | gen-mdbook-summary |
| lib.rs | gen-mdbook-summary |
| version | 0.0.5 |
| source | src |
| created_at | 2024-06-16 16:20:40.818212 |
| updated_at | 2024-06-19 18:01:02.839102 |
| description | A tool to generate SUMMARY.md for mdbook project |
| homepage | |
| repository | https://github.com/cncsmonster/gen-mdbook-summary |
| max_upload_size | |
| id | 1273669 |
| size | 22,540 |
(CNCSMonster)
documentation
README
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.