From 2415d88d92567ee2a863bb9db96ebdac80769c4e Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Tue, 10 Mar 2020 16:28:08 -0700 Subject: [PATCH] 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 --- .gitignore | 2 +- book/book.toml | 6 ++++++ book/src/SUMMARY.md | 3 +++ book/src/notes.md | 1 + justfile | 5 +++++ 5 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 book/book.toml create mode 100644 book/src/SUMMARY.md create mode 100644 book/src/notes.md diff --git a/.gitignore b/.gitignore index 8346370..60c65c4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ /target **/*.rs.bk -notes.md +/book/book diff --git a/book/book.toml b/book/book.toml new file mode 100644 index 0000000..2a2707f --- /dev/null +++ b/book/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["Casey Rodarmor"] +language = "en" +multilingual = false +src = "src" +title = "imdl" diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md new file mode 100644 index 0000000..1d52881 --- /dev/null +++ b/book/src/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Notes](./notes.md) diff --git a/book/src/notes.md b/book/src/notes.md new file mode 100644 index 0000000..17e0f0d --- /dev/null +++ b/book/src/notes.md @@ -0,0 +1 @@ +# Notes diff --git a/justfile b/justfile index 4163e2a..923fea3 100644 --- a/justfile +++ b/justfile @@ -42,12 +42,17 @@ lint: preview-readme: grip -b README.md +# build and serve the book +book: + mdbook serve book --open + # add git log messages to changelog changes: git log --pretty=format:%s >> CHANGELOG.md dev-deps: brew install grip + cargo install mdbook # update readme table of contents update-toc: