amiauth/mkdocs.yml at main · sidick/amiauth · 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
# User documentation site (MkDocs Material), published per release via mike
# to GitHub Pages — see .github/workflows/docs.yml and userdocs/README note
# in CLAUDE.md. Developer design notes stay in docs/ and are not part of
# this site.

site_name: AmiAuth
site_description: A native two-factor authentication (2FA) code generator for classic AmigaOS
site_url: https://sidick.github.io/amiauth/
repo_url: https://github.com/sidick/amiauth
repo_name: sidick/amiauth
edit_uri: edit/main/userdocs/
copyright: AmiAuth — a native 2FA authenticator for classic 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

extra:
  version:
    provider: mike

markdown_extensions:
  - toc:
      permalink: true

# Mirrors the old wiki _Sidebar.md grouping.
nav:
  - Home: index.md
  - Getting going:
      - Installation: Installation.md
      - Getting Started: Getting-Started.md
  - Using AmiAuth:
      - Managing Accounts: Managing-Accounts.md
      - CLI Reference: CLI-Reference.md
      - GUI Guide: GUI-Guide.md
      - Commodity and Tooltypes: Commodity-and-Tooltypes.md
      - ARexx Port: ARexx-Port.md
      - Time and Clock Sync: Time-and-Clock-Sync.md
  - Under the hood:
      - Vault and Passphrases: Vault-and-Passphrases.md
      - Settings Reference: Settings-Reference.md
      - Localization: Localization.md
      - Security Model: Security-Model.md
  - Help:
      - Troubleshooting and FAQ: Troubleshooting-and-FAQ.md
      - Building from Source: Building-from-Source.md
      - Changelog: Changelog.md