book-summary

自动为您的书籍 (mdbook/gitbook) 创建 SUMMARY.md 文件

类似于自动摘要工具的 npm 版本 gh/imfly/gitbook-summary，这里是一个 rust 版本。

我的最初目的是在不重命名带有前缀数字的章节文件夹的情况下对章节进行排序。 -s 选项接受应该首先出现的章节名称。我在我的个人笔记仓库 notes 中使用它。

安装

OS X & Linux

cargo install book-summary

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

使用示例

# create a SUMMARY.md file with custom sort in mdBook format
$ book-summary -n ./notes --sort tech personal

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>            Format md/git book [default: md]
    -n, --notesdir <notesdir>        Notes dir where to parse all your notes from [default: ./]
    -o, --outputfile <outputfile>    Output file [default: SUMMARY.md]
    -s, --sort <sort>...             Start with following chapters
    -t, --title <title>              Title for summary [default: Summary]

贡献

请随意提交一个 pull request 或 issue 以贡献到此项目。

作者

• Dimitrij Vogt - 初始工作 - gh/dvogt23
• Miguel Berrio - 贡献 - gh/B3RR10

另请参阅参与此项目的 贡献者列表。

许可证

本项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE.md 文件。