GitXplorerGitXplorer
y

mdbook-generate-summary

public
6 stars
4 forks
3 issues

Commits

List of commits on branch main.
Unverified
1e29b76fa43b97981b87bcb515af86a9526c8917

Sort chapters using human ordering

yyounata committed 2 years ago
Unverified
64cf0ac7957c5ab49c79e1aee3c70fa10bfc6908

Bump version

yyounata committed 6 years ago
Unverified
e74c085c7e8fc09eecf05ca0bb35a7a9997e669d

SummaryEntry comparisons are now entirely based off the paths given

yyounata committed 6 years ago
Unverified
031bcb2d2052bb1bac393b175942ae2c0bb00aae

Workaround for SUMMARY.md titles not numbered titles

yyounata committed 6 years ago
Unverified
a55237b7b26442569448505f147d937e8d4e826e

Add dockerfile, which doesn't download from crates.

yyounata committed 6 years ago
Unverified
cc7e979b8e0295523494cb970fef3619277f2555

Initial commit

yyounata committed 6 years ago

README

The README file for this repository.

mdbook-generate-summary

This is a CLI tool to generate the SUMMARY.md page for an mdBook repository.

This is a tool I wrote because I'm abusing mdBook to act as a knowledge repository, and not as an actual book. I wanted to streamline the process of adding pages as much as possible, and not have to worry too much about maintaining that SUMMARY.md.

This does, however, make a few assumptions on the layout of your book:

Each subpage has an accompanying README.md.

E.G. Your book will always have the following directory tree under the src/:

foo.md
bar/README.md
bar/something_else.md
baz/README.md

That is, you'll never have a directory with a .md file in it, that doesn't ALSO have a README.md file.

If you do, the program won't detect that edge case, and it won't do the right thing.