docs: Build with mdBook
Signed-off-by: Tim Crawford <tcrawford@system76.com>
This commit is contained in:
committed by
Jeremy Soller
parent
bd291871f4
commit
9b7c6704c3
4
Makefile
4
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)
|
||||
|
10
docs/SUMMARY.md
Normal file
10
docs/SUMMARY.md
Normal file
@ -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)
|
20
docs/book.toml
Normal file
20
docs/book.toml
Normal file
@ -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
|
Reference in New Issue
Block a user