build: provide mdBook in Nix shell
This commit is contained in:
1 parent
8f91247f10
commit
a4f04cfa7e
3 files changed
+5
-4
No files matched your search
@@ -33,7 +33,7 @@ jobs:
|
||||
uses: actions/configure-pages@v5
|
||||
|
||||
- name: Install mdBook
|
||||
run: cargo install mdbook --version 0.5.2 --locked
|
||||
run: cargo install mdbook --version 0.5.3 --locked
|
||||
|
||||
- name: Build the site
|
||||
run: mdbook build docs
|
||||
|
||||
@@ -30,11 +30,11 @@ Do not add board-local READMEs. Add a page here instead, then link it from
|
||||
|
||||
## Build the documentation website
|
||||
|
||||
The manual is an [mdBook](https://rust-lang.github.io/mdBook/) project. Build
|
||||
it locally with a compatible `mdbook` binary:
|
||||
The manual is an [mdBook](https://rust-lang.github.io/mdBook/) project. The
|
||||
repository's Nix development shell provides the checked tool version:
|
||||
|
||||
```sh
|
||||
make -C docs build
|
||||
nix develop -c make -C docs build
|
||||
```
|
||||
|
||||
The generated static site is written to `target/docs/`. The GitHub Pages
|
||||
|
||||
Reference in new issue
Block a user