LinuxBoot book which contains the documentation in markdown format
LinuxBoot is a project that aims to replace specific firmware functionality with
a Linux kernel and runtime. Over the years this project has grown to include
various initiatives with the overarching goal of moving from obscure, complex
firmware to simpler, open source firmware.
This is the official site of documentation for the LinuxBoot project. The book
provides guidance on how to get started, and gives overviews and
background on the different aspects of LinuxBoot.
This book is written with mdBook.
When installed, run mdbook serve
and you will get a local webserver.
For more details, please refer to the mdBook documentation.
Some pages render diagrams using mermaid.js, which is
preprocessed with mdbook-mermaid.
To check that all links are still available, mdbook-linkcheck also runs in CI.
For convenience, the Makefile
lets you set up and run the environment:
make prepare
make run
The book is linted with markdownlint and Vale. Follow the official
documentation to install
markdownlint
and install Vale. Then run vale sync
to
download the necessary styles.
From the root directory of the repository run mdl /src/example.md
and vale src/example.md
. Add words that trigger false positive spelling errors to
ci/vale/styles/config/vocabularies/LinuxBoot/accept.txt
.
Translations are in po/
. They are built with i18n.sh
.
Until there is a native mdBook plugin, see the Makefile
for how
the translations are integrated.
Note that make run
/ mdbook serve
do not integrate the translations at this
point. The make build
target will build everything into book/
, which you
can then statically serve.
In alphabetical order: