remote-lab/mkdocs_custom.yml at develop · zebbra/remote-lab · 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
site_name: Neops Remote Lab

# Project-only extensions on top of the canonical base
# (zebbra/mkdocs-documentation/assets/mkdocs_base.yml). Everything else
# the docs use — tabs, tasklist, abbr, smarty, smartsymbols, magiclink,
# betterem — is now part of the base and applies site-wide.
markdown_extensions:
  - def_list  # glossary entries + REST endpoint fields

nav:
  - Start: index.md
  - Get started:
      - "Get started": getting-started/index.md
      - "Run your first test": getting-started/10-pytest.md
      - "Plug into Worker SDK": getting-started/15-worker-sdk.md
      - "Run locally": getting-started/20-local.md
      - "Drive from cURL": getting-started/30-curl.md
      - "Wire into CI": getting-started/40-ci.md
  - Use from Python:
      - "Use from Python": 20-client/index.md
      - "Pytest fixtures": 20-client/10-pytest-fixtures.md
      - "With Worker SDK": 20-client/15-worker-sdk.md
      - "Python client": 20-client/20-python-client.md
      - "Client config": 20-client/30-configuration.md
  - Run the service:
      - "Run the service": 30-server/index.md
      - "Operator runbook": 30-server/10-administration.md
      - "Server config": 30-server/20-configuration.md
      - "Security model": 30-server/30-security.md
      - "REST API": 30-server/40-rest-api.md
      - "Debugging": 30-server/50-debugging.md
  - Set up a host:
      - "Set up a host": 40-deployment/index.md
      - "Pick a deployment": 40-deployment/05-pick-deployment.md
      - Lab platform:
          - "Netlab host": 40-deployment/10-netlab-host-setup.md
          - "Vendor setup": 40-deployment/20-vendor-setup.md
      - Networking:
          - "Network access": 40-deployment/25-network-enclosure.md
          - "Headscale Quick start": 40-deployment/30-headscale-quick-setup.md
          - "Headscale Reference": 40-deployment/40-headscale-reference.md
  - Concepts:
      - "Concepts": 10-concepts/index.md
      - "Three-minute tour": 10-concepts/05-tour.md
      - "Architecture": 10-concepts/10-architecture.md
      - "Session queue": 10-concepts/20-session-queue.md
      - "Lab lifecycle": 10-concepts/30-lab-lifecycle.md
      - "Topology format": 10-concepts/40-topology-format.md
  - Contributing:
      - "Contributing": 50-contributing/index.md
      - "Your first PR": 50-contributing/05-first-pr.md
      - "Dev setup": 50-contributing/10-dev-setup.md
      - "Invariants": 50-contributing/20-invariants.md
      - "Async discipline": 50-contributing/30-internals-async.md
      - "LabManager": 50-contributing/40-internals-lab-manager.md
      - "atexit & lifespan": 50-contributing/50-internals-atexit.md
      - "Test stubbing": 50-contributing/60-internals-test-stubbing.md
      - "Anti-patterns": 50-contributing/70-anti-patterns.md
  - Appendix:
      - "Appendix": 99-appendix/index.md
      - "Glossary": 99-appendix/glossary.md
      - "Cookbook": 99-appendix/cookbook.md
      - "Neops ecosystem": 99-appendix/neops-ecosystem.md
#  - Dummy Project: '!include ./submodules/zebbra-mkdocs-dummyproject/mkdocs_custom.yml'


# --8<-- [start:theme]
theme:
  # Sticky top tabs, breadcrumb path, and toc.follow are now in the
  # canonical base (zebbra/mkdocs-documentation). Only project-specific
  # palette overrides live here.
  # Dark and light mode, defaults to system theme
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
# --8<-- [end:theme]

# --8<-- [start:repo]
repo_url: https://github.com/zebbra/remote-lab
edit_uri: edit/main/docs
# --8<-- [end:repo]

# --8<-- [start:social]
extra:
  social:
    - icon: fontawesome/solid/house
      link: https://zebbra.ch
      name: Zebbra
# --8<-- [end:social]

# --8<-- [start:copyright]
copyright: Copyright &copy; Zebbra AG
# --8<-- [end:copyright]

plugins:
  # Enables search
  # - git-authors
  # - git-revision-date-localized
  # Monorepo allows to use the !include in the navigation
  - monorepo
  - exclude:
      glob:
        - '*.tmp'
        - '*.pdf'
        - '*.gz'
        - node_modules
        - '**/node_modules/*'
        - .venv
        - '**/.venv/*'
        # Snippets dir — auto-appended on every page; not a nav page itself.
        - includes/*
      regex:
        - .*\.(tmp|bin|tar)$