sana2loop/mkdocs.yml at main · sidick/sana2loop · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# User documentation site (MkDocs Material), published to GitHub Pages at
# site_url below via .github/workflows/docs.yml (mike-based versioned
# deploy, adapted from sibling project amiauth's own docs.yml -- each
# release tag deploys under its own version plus a floating "latest"
# alias). First published 2026-07-31, ahead of any release tag, under
# "v1.0" (matching version.mk's eventual first release version) via that
# workflow's workflow_dispatch trigger. PRs/pushes to main only get a
# strict build check (ci.yml's docs-build job) so the site can't silently
# rot between real publishes -- day-to-day doc edits don't redeploy until
# the next release tag or a manual dispatch. Developer design notes stay
# in docs/ and are not part of this site.

site_name: sana2loop
site_description: A hardware-free SANA-II network device for AmigaOS
site_url: https://sidick.github.io/sana2loop/
repo_url: https://github.com/sidick/sana2loop
repo_name: sidick/sana2loop
edit_uri: edit/main/userdocs/
copyright: sana2loop — a hardware-free SANA-II device for AmigaOS. BSD 2-Clause.

docs_dir: userdocs

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.footer
    - content.action.edit

markdown_extensions:
  - toc:
      permalink: true

# Enables the mike-based version picker in the theme header -- matches
# the mike-versioned deploy in .github/workflows/docs.yml.
extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting going:
      - Installation: Installation.md
      - Getting Started: Getting-Started.md
  - Using loopback.device:
      - Configuration Reference: Configuration-Reference.md
      - Echo and Crossover Modes: Echo-and-Crossover.md
      - Replay and Record: Replay-and-Record.md
      - Fault Injection: Fault-Injection.md
      - SanaInfo Reference: SanaInfo-Reference.md
      - SanaDump and SanaSend: SanaDump-and-SanaSend.md
      - SANA-II Conformance: SANA-II-Conformance.md
  - Help:
      - Troubleshooting and FAQ: Troubleshooting-and-FAQ.md
      - Building and Testing: Building-and-Testing.md
      - Changelog: Changelog.md