docs: Build with mdBook
Signed-off-by: Tim Crawford <tcrawford@system76.com>
This commit is contained in:
committed by
Jeremy Soller
parent
6407caab03
commit
cab3891487
@@ -1 +0,0 @@
|
||||
# System76 Open Firmware Documentation
|
9
docs/SUMMARY.md
Normal file
9
docs/SUMMARY.md
Normal 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
18
docs/book.toml
Normal 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
7
docs/index.md
Normal 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
|
Reference in New Issue
Block a user