Wiki-like GitBook books
This package comes in two parts: a command-line tool to:
- Automatically populate
SUMMARY.md
with an index of all pages - Generate directory index pages
and a GitBook plugin to:
- Insert breadcrumbs
- Check for broken links
- Check for orphaned pages
Usage
Add "wikify"
to the list of plugins in your book.json
:
Then run gitbook install
.
Building your book now requires two steps:
node_modules/.bin/gitbook-autoindexgitbook build
You may want to add files that are automatically generated by the autoindexer to
.gitignore
; in which case, they should be un-ignored in .bookignore
so that
they're properly included in the book:
$ cat .gitignore_index.mdSUMMARY.md $ cat .bookignore!_index.md!SUMMARY.md
Directory Index
The automatically generated index page is pretty bare-bones. If you want to use
your own index, create an index.md
file under the directory and it will be
copied as-is.
Any link to a directory will be rewritten as a link to <dir>/_index.md
.
Breadcrumbs
Breadcrumbs will have this HTML structure:
Top > network > router.md
Broken Links
Broken links are reported in GitBook build's console output in TAP format.
ok links ok in copy.mdok links ok in retro.mdnot ok link broken in README.md -> errors.md, benchmark.org, tooling.md
Orphaned Pages
Orphaned pages are reported in the lintOutput
file, if specified, in jslint's XML format.