Add empty book
The book should eventually contain all documentation that isn't suitable for the readme or help text. For now it's empty, but it seemed useful to add the scaffolding, so adding to it is low friction. type: documentation
This commit is contained in:
parent
21a87a46f3
commit
2415d88d92
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,3 +1,3 @@
|
||||||
/target
|
/target
|
||||||
**/*.rs.bk
|
**/*.rs.bk
|
||||||
notes.md
|
/book/book
|
||||||
|
|
6
book/book.toml
Normal file
6
book/book.toml
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
[book]
|
||||||
|
authors = ["Casey Rodarmor"]
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "src"
|
||||||
|
title = "imdl"
|
3
book/src/SUMMARY.md
Normal file
3
book/src/SUMMARY.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Summary
|
||||||
|
|
||||||
|
- [Notes](./notes.md)
|
1
book/src/notes.md
Normal file
1
book/src/notes.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Notes
|
5
justfile
5
justfile
|
@ -42,12 +42,17 @@ lint:
|
||||||
preview-readme:
|
preview-readme:
|
||||||
grip -b README.md
|
grip -b README.md
|
||||||
|
|
||||||
|
# build and serve the book
|
||||||
|
book:
|
||||||
|
mdbook serve book --open
|
||||||
|
|
||||||
# add git log messages to changelog
|
# add git log messages to changelog
|
||||||
changes:
|
changes:
|
||||||
git log --pretty=format:%s >> CHANGELOG.md
|
git log --pretty=format:%s >> CHANGELOG.md
|
||||||
|
|
||||||
dev-deps:
|
dev-deps:
|
||||||
brew install grip
|
brew install grip
|
||||||
|
cargo install mdbook
|
||||||
|
|
||||||
# update readme table of contents
|
# update readme table of contents
|
||||||
update-toc:
|
update-toc:
|
||||||
|
|
Loading…
Reference in New Issue
Block a user