diff --git a/.gitignore b/.gitignore index 0f4b3f00..48d36535 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +book/ build/ terraform-*-tmp-*/ diff --git a/docs/Makefile b/docs/Makefile index eed6c7ea..508d0c24 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,5 +1,7 @@ .POSIX: +default: book + .PHONY: todo todo: printf "# TODO\n\n" > todo.md @@ -12,3 +14,7 @@ todo: diagrams: cd diagrams \ && python * + +.PHONY: book +book: todo + mdbook build . diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 00000000..68bbc7ae --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,9 @@ +# Summary + +[Introduction](./introduction.md) + +--- + +[Changelog](./changelog.md) +[Roadmap](./roadmap.md) +[Todo](./todo.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 00000000..79dff38c --- /dev/null +++ b/docs/book.toml @@ -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}" diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 00000000..e10b99d0 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1 @@ +# Introduction diff --git a/tools/Dockerfile b/tools/Dockerfile index 68be9a19..eee57186 100644 --- a/tools/Dockerfile +++ b/tools/Dockerfile @@ -13,6 +13,7 @@ RUN yes | pacman --sync --refresh \ kubectl \ libisoburn \ make \ + mdbook \ p7zip \ python \ python-netaddr \