libaaa/mkdocs.yml at main · Moxibyte/libaaa · 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
# Project information
site_name: LibAAA
site_description: LibAAA is a cross platform radius (AAA) protocol library written in C99 with C++ bindings.
site_author: Ludwig Fuechsl
copyright: >-
  &copy; Copyright 2023 Moxibyte GmbH<br/>
  <br/>
  <a href="https://moxibyte.com/imprint.html" target="_blank">Impressum</a> |
  <a href="https://moxibyte.com/datenschutz.html" target="_blank">Datenschutzerklärung</a>

# GitHub repository link
repo_url: https://github.com/moxibyte/libaaa
edit_uri: blob/main/documentation

# TODO: Deploy options

# File locations
docs_dir: docs

# Navigation
nav:
  - About: "index.md"
  - LibAAA:
    - About: "libaaa/index.md"
    - libaaa_pg:
      - Reference: "libaaa/libaaa_pg/reference.md"
      - User Guide: "libaaa/libaaa_pg/guide.md"
      - Example: "libaaa/libaaa_pg/example.md"
    - libaaa_pr:
      - Reference: "libaaa/libaaa_pr/reference.md"
      - User Guide: "libaaa/libaaa_pr/guide.md"
      - Example: "libaaa/libaaa_pr/example.md"
    - "libaaa::packet_generator":
      - Reference: "libaaa/packet_generator/reference.md"
      - User Guide: "libaaa/packet_generator/guide.md"
      - Example: "libaaa/packet_generator/example.md"
    - "libaaa::packet_reader":
      - Reference: "libaaa/packet_reader/reference.md"
      - User Guide: "libaaa/packet_reader/guide.md"
      - Example: "libaaa/packet_reader/example.md"
  - LibAAA-Server: "libaaa-server/index.md"
  - LibAAA-Client: "libaaa-client/index.md"

# Markdown extensions
markdown_extensions:
  # Checked list
  - pymdownx.tasklist:
      custom_checkbox: true
  # Code hilight
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # Footnotes
  - footnotes
  # admonition (Alerts)
  - admonition
  - pymdownx.details
  # Icons
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  # Annotations
  - md_in_html

# Visual customisation
theme:
  name: material

  # Customize
  icon:
    logo: material/key
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - content.code.copy
    - content.code.annotate

  # Light and Dark mode
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# Cookie consent
extra:
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.