Skip to content

Commit cab3891

Browse files
crawfxrdjackpot51
authored andcommitted
docs: Build with mdBook
Signed-off-by: Tim Crawford <[email protected]>
1 parent 6407caa commit cab3891

File tree

4 files changed

+34
-1
lines changed

4 files changed

+34
-1
lines changed

docs/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/SUMMARY.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Summary
2+
3+
- [Index](./index.md)
4+
- [Firmware features](./features.md)
5+
- [Flashing firmware](./flashing.md)
6+
- [Debugging](./debugging.md)
7+
- [Adding a new board](./adding-a-new-board.md)
8+
- [Intel CSME](./intel-me.md)
9+
- [UEFI](./uefi.md)

docs/book.toml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[book]
2+
title = "System76 Open Firmware"
3+
description = "System76 Open Firmware documentation"
4+
language = "en"
5+
src = "."
6+
7+
[build]
8+
build-dir = "../build/docs"
9+
create-missing = false
10+
11+
[output.html]
12+
default-theme = "rust"
13+
preferred-dark-theme = "coal"
14+
no-section-label = true
15+
git-repository-url = "https://github.com/system76/firmware-open"
16+
17+
[output.html.print]
18+
enable = false

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Documentation
2+
3+
This is the documentation for System76 Open Firmware. It is set up to be used
4+
with [mdBook], which can generate HTML output for easy navigation.
5+
6+
7+
[mdBook]: https://github.com/rust-lang/mdBook

0 commit comments

Comments
 (0)