From cab389148786633305620fcc8e3cad0744f3f465 Mon Sep 17 00:00:00 2001 From: Tim Crawford Date: Wed, 21 Feb 2024 08:40:01 -0700 Subject: [PATCH] docs: Build with mdBook Signed-off-by: Tim Crawford --- docs/README.md | 1 - docs/SUMMARY.md | 9 +++++++++ docs/book.toml | 18 ++++++++++++++++++ docs/index.md | 7 +++++++ 4 files changed, 34 insertions(+), 1 deletion(-) delete mode 100644 docs/README.md create mode 100644 docs/SUMMARY.md create mode 100644 docs/book.toml create mode 100644 docs/index.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 4629728..0000000 --- a/docs/README.md +++ /dev/null @@ -1 +0,0 @@ -# System76 Open Firmware Documentation diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..8a6ed21 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,9 @@ +# Summary + +- [Index](./index.md) +- [Firmware features](./features.md) +- [Flashing firmware](./flashing.md) +- [Debugging](./debugging.md) +- [Adding a new board](./adding-a-new-board.md) +- [Intel CSME](./intel-me.md) +- [UEFI](./uefi.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..e672abd --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,18 @@ +[book] +title = "System76 Open Firmware" +description = "System76 Open Firmware documentation" +language = "en" +src = "." + +[build] +build-dir = "../build/docs" +create-missing = false + +[output.html] +default-theme = "rust" +preferred-dark-theme = "coal" +no-section-label = true +git-repository-url = "https://github.com/system76/firmware-open" + +[output.html.print] +enable = false diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..9574bd1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# Documentation + +This is the documentation for System76 Open Firmware. It is set up to be used +with [mdBook], which can generate HTML output for easy navigation. + + +[mdBook]: https://github.com/rust-lang/mdBook