Skip to content

Commit 2b778d8

Browse files
committed
docs: update mdbook
1 parent 360a47e commit 2b778d8

File tree

8 files changed

+1043
-1006
lines changed

8 files changed

+1043
-1006
lines changed

.github/workflows/build-docs.yaml

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,24 @@ on:
1313
paths:
1414
- "docs/**"
1515

16-
env:
17-
SCCACHE_VERSION: v0.7.7
18-
1916
jobs:
2017
build:
2118
runs-on: ubuntu-latest
2219
steps:
2320
- uses: actions/checkout@v4
24-
- name: Setup rust toolchain
25-
uses: dtolnay/rust-toolchain@nightly
26-
- name: Obtain sccache
27-
run: |
28-
curl -fsSL https://github.com/mozilla/sccache/releases/download/${SCCACHE_VERSION}/sccache-${SCCACHE_VERSION}-x86_64-unknown-linux-musl.tar.gz \
29-
| tar xz sccache-${SCCACHE_VERSION}-x86_64-unknown-linux-musl/sccache --strip=1
30-
- name: Configure sccache
31-
uses: actions/github-script@v6
21+
- name: Install Nix
22+
uses: DeterminateSystems/nix-installer-action@v10
3223
with:
33-
script: |
34-
core.exportVariable('RUSTC_WRAPPER', './sccache')
35-
core.exportVariable('SCCACHE_GHA_ENABLED', 'on')
36-
core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
37-
core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
38-
- name: Install mdBook and dependencies
39-
run: cargo install mdbook mdbook-admonish
24+
extra-conf: |
25+
experimental-features = nix-command flakes
26+
4027
- name: Build site
41-
run: mdbook build docs
28+
run: "nix develop .#devShells.x86_64-linux.docs -c mdbook build docs"
29+
4230
- name: Upload built site as artifact
4331
uses: actions/upload-pages-artifact@v3
4432
with:
4533
path: ./docs/dist
46-
- name: Get some statistics
47-
run: ./sccache --show-stats
4834

4935
deploy:
5036
environment:

docs/book.toml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ authors = ["Cassie Cheung"]
33
language = "en"
44
multilingual = false
55
src = "src"
6-
title = "genso-nix"
6+
title = "gensokyo"
77

88
[build]
99
build-dir = "./dist"
1010

1111
[output.html]
1212
default-theme = "latte"
1313
preferred-dark-theme = "mocha"
14-
git-repository-url = "https://patchy.soopy.moe/cassie/genso-nix"
14+
git-repository-url = "https://patchy.soopy.moe/cassie/gensokyo"
1515
git-repository-icon = "fa-code-fork"
16-
edit-url-template = "https://patchy.soopy.moe/cassie/genso-nix/_edit/main/docs/{path}"
16+
edit-url-template = "https://patchy.soopy.moe/cassie/gensokyo/_edit/main/docs/{path}"
1717
cname = "flake.soopy.moe"
1818

1919
additional-js = ["theme/pagetoc.js"]
@@ -25,6 +25,5 @@ assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
2525

2626
[preprocessor.pagetoc]
2727

28-
2928
# [preprocessor.catppuccin]
3029
# assets_version = "2.1.0" # DO NOT EDIT: Managed by `mdbook-catppuccin install`

docs/src/SUMMARY.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22
[Welcome to the Cow](README.md)
33

44
# Documentation
5-
- [Tips and Tricks](./tips/README.md)
6-
- [Overriding packages](./tips/overriding-packages.md)
7-
- [Overlays](./tips/overlays.md)
8-
- ["Global" Options](./tips/global-options.md)
9-
- [Passing large secrets to DynamicUser=true services](./tips/pass-big-secrets-to-dynamic-user.md)
10-
- [Miscellaneous Tips](./tips/misc.md)
11-
- [Pitfalls](./tips/pitfalls.md)
12-
- [Utility Functions](./utils/README.md)
13-
- [mkVhost](./utils/mkVhost.md)
14-
- [mkSimpleProxy](./utils/mkSimpleProxy.md)
15-
- [genSecrets](./utils/genSecrets.md)
16-
- [setupSecrets](./utils/setupSecrets.md)
17-
- [mkNginxFile](./utils/mkNginxFile.md)
18-
- [mkNginxJSON](./utils/mkNginxJSON.md)
5+
- [Tips and Tricks](tips/README.md)
6+
- [Overriding packages](tips/overriding-packages.md)
7+
- [Overlays](tips/overlays.md)
8+
- ["Global" Options](tips/global-options.md)
9+
- [Passing large secrets to DynamicUser=true services](tips/pass-big-secrets-to-dynamic-user.md)
10+
- [Miscellaneous Tips](tips/misc.md)
11+
- [Pitfalls](tips/pitfalls.md)
12+
- [Utility Functions](utils/README.md)
13+
- [mkVhost](utils/mkVhost.md)
14+
- [mkSimpleProxy](utils/mkSimpleProxy.md)
15+
- [genSecrets](utils/genSecrets.md)
16+
- [setupSecrets](utils/setupSecrets.md)
17+
- [mkNginxFile](utils/mkNginxFile.md)
18+
- [mkNginxJSON](utils/mkNginxJSON.md)
1919

2020
# Internal documentation
2121
- ["Private" use]()
22-
- [Ports](./internal/ports.md)
23-
- [External Untracked Files](./internal/ext-files.md)
22+
- [Ports](internal/ports.md)
23+
- [External Untracked Files](internal/ext-files.md)
2424
- [Presets]()
25-
- [`certificates`](./internal/presets/certificates.md)
26-
- [`nginx`](./internal/presets/nginx.md)
27-
- [`vmetrics`](./internal/presets/vmetrics.md)
25+
- [`certificates`](internal/presets/certificates.md)
26+
- [`nginx`](internal/presets/nginx.md)
27+
- [`vmetrics`](internal/presets/vmetrics.md)

0 commit comments

Comments
 (0)