From 9b7c6704c3c6db69e4001974b86169be31c04f58 Mon Sep 17 00:00:00 2001 From: Tim Crawford Date: Wed, 19 Jul 2023 07:37:52 -0600 Subject: [PATCH] docs: Build with mdBook Signed-off-by: Tim Crawford --- Makefile | 4 ++++ docs/SUMMARY.md | 10 ++++++++++ docs/book.toml | 20 ++++++++++++++++++++ docs/{README.md => index.md} | 0 4 files changed, 34 insertions(+) create mode 100644 docs/SUMMARY.md create mode 100644 docs/book.toml rename docs/{README.md => index.md} (100%) diff --git a/Makefile b/Makefile index 149918a..7fb3773 100644 --- a/Makefile +++ b/Makefile @@ -66,6 +66,10 @@ include $(ARCH_DIR)/toolchain.mk # The architecture defines build targets, no more is required endif +.PHONY: docs +docs: + mdbook build docs/ + .PHONY: clean clean: rm -rf $(obj) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..ae1641f --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,10 @@ +# Summary + +- [Index](./index.md) +- [Development environment](./dev-env.md) +- [Adding a new board](./adding-a-new-board.md) +- [Supported controllers](./controllers.md) +- [Debugging](./debugging.md) +- [Flashing](./flashing.md) +- [Custom keyboard layouts](./keyboard-layout-customization.md) +- [Mega2560](./mega2560.md) diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..7c60b26 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,20 @@ +# SPDX-License-Identifier: GPL-3.0-only + +[book] +title = "System76 EC" +description = "System76 EC 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/ec" + +[output.html.print] +enable = false diff --git a/docs/README.md b/docs/index.md similarity index 100% rename from docs/README.md rename to docs/index.md