Jaculus-link/mkdocs.yml at master · jaculus-org/Jaculus-link · 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
site_url: https://link.jaculus.org
site_name: Jaculus-link - A communication library
site_description: >-
  Jaculus-link is a communication library that allows programs to communicate using virtual channels over a single
  stream connection. It does not contain bindings for communication interfaces but provides a simple API for creating them.
site_author: Petr Kubica

repo_url: https://github.com/jaculus-org/Jaculus-link
repo_name: jaculus-org/Jaculus-link

copyright: Copyright © 2025 Petr Kubica

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.expand
    - navigation.indexes

  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true

plugins:
  - search:
      lang: en
  - mkdoxy:
      projects:
        doxygen:
          src-dirs: src
          full-doc: True
          doxy-cfg:
            FILE_PATTERNS: "*.cpp *.h*"
            EXAMPLE_PATH: examples
            RECURSIVE: True

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Usage: usage.md
  - API:
    - Class Index: "doxygen/classes.md"
    - Namespace List: "doxygen/namespaces.md"
    - File list: "doxygen/files.md"