mirror of
https://github.com/khuedoan/homelab.git
synced 2024-12-23 01:04:32 +07:00
Use mdbook (from the Rust project) for documentation
This commit is contained in:
parent
9795cfb25a
commit
dfbfd8d138
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,3 +1,4 @@
|
|||||||
|
book/
|
||||||
build/
|
build/
|
||||||
terraform-*-tmp-*/
|
terraform-*-tmp-*/
|
||||||
|
|
||||||
|
@ -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
9
docs/SUMMARY.md
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# Summary
|
||||||
|
|
||||||
|
[Introduction](./introduction.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[Changelog](./changelog.md)
|
||||||
|
[Roadmap](./roadmap.md)
|
||||||
|
[Todo](./todo.md)
|
10
docs/book.toml
Normal file
10
docs/book.toml
Normal 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
1
docs/introduction.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
# Introduction
|
@ -13,6 +13,7 @@ RUN yes | pacman --sync --refresh \
|
|||||||
kubectl \
|
kubectl \
|
||||||
libisoburn \
|
libisoburn \
|
||||||
make \
|
make \
|
||||||
|
mdbook \
|
||||||
p7zip \
|
p7zip \
|
||||||
python \
|
python \
|
||||||
python-netaddr \
|
python-netaddr \
|
||||||
|
Loading…
Reference in New Issue
Block a user