docs: Build with mdBook

Signed-off-by: Tim Crawford <tcrawford@system76.com>
This commit is contained in:
Tim Crawford
2024-02-21 08:40:01 -07:00
committed by Jeremy Soller
parent 6407caab03
commit cab3891487
4 changed files with 34 additions and 1 deletions

View File

@@ -1 +0,0 @@
# System76 Open Firmware Documentation

9
docs/SUMMARY.md Normal file
View File

@@ -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)

18
docs/book.toml Normal file
View File

@@ -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

7
docs/index.md Normal file
View File

@@ -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