#mdbook #summary #md #generate #file #ignore #directory

app gen-mdbook-summary

生成mdbook项目SUMMARY.md文件的工具

6个版本

0.0.5 2024年6月19日
0.0.4 2024年6月19日

#md中排名5

MIT许可协议

9KB
193 代码行

gen-mdbook-summary

描述

这是一个用于为mdBook项目生成SUMMARY.md文件的简单工具。

安装和用法

快速入门

# 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 https://127.0.0.1:3000
mdbook serve

更多用法,请查看帮助信息

gms --help

以及示例目录

许可协议

LICENSE

依赖项

~5–14MB
~167K SLoC