Use mdbook (from the Rust project) for documentation

This commit is contained in:
Khue Doan 2021-07-02 19:08:25 +07:00
parent 9795cfb25a
commit dfbfd8d138
6 changed files with 28 additions and 0 deletions

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
book/
build/ build/
terraform-*-tmp-*/ terraform-*-tmp-*/

View File

@ -1,5 +1,7 @@
.POSIX: .POSIX:
default: book
.PHONY: todo .PHONY: todo
todo: todo:
printf "# TODO\n\n" > todo.md printf "# TODO\n\n" > todo.md
@ -12,3 +14,7 @@ todo:
diagrams: diagrams:
cd diagrams \ cd diagrams \
&& python * && python *
.PHONY: book
book: todo
mdbook build .

9
docs/SUMMARY.md Normal file
View File

@ -0,0 +1,9 @@
# Summary
[Introduction](./introduction.md)
---
[Changelog](./changelog.md)
[Roadmap](./roadmap.md)
[Todo](./todo.md)

10
docs/book.toml Normal file
View File

@ -0,0 +1,10 @@
[book]
authors = ["Khue Doan"]
language = "en"
multilingual = false
src = "."
title = "Khue's Homelab"
[output.html]
git-repository-url = "https://github.com/khuedoan/homelab"
edit-url-template = "https://github.com/khuedoan/homelab/edit/master/docs/{path}"

1
docs/introduction.md Normal file
View File

@ -0,0 +1 @@
# Introduction

View File

@ -13,6 +13,7 @@ RUN yes | pacman --sync --refresh \
kubectl \ kubectl \
libisoburn \ libisoburn \
make \ make \
mdbook \
p7zip \ p7zip \
python \ python \
python-netaddr \ python-netaddr \