rocd/mkdocs.yml at main · roc-streaming/rocd · 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
site_name: rocd documentation
copyright: Copyright (c) Roc Streaming authors.

repo_url: https://github.com/roc-streaming/rocd
edit_uri: https://github.com/roc-streaming/rocd/edit/main/docs/

use_directory_urls: false

theme:
  name: material
  features:
    - navigation.sections
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.extra
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

extra_css:
  - stylesheets/extra.css

nav:
  - Overview: index.md
  - Usage:
      - Platform support: usage/platforms.md
  - Implementation:
      - Architecture: implementation/architecture.md
      - Glossary: implementation/glossary.md
      - P2P protocol: implementation/p2p_protocol.md
      - Use of Roc Toolkit: implementation/roc_toolkit.md
      - Relation to Roc Cast: implementation/roc_cast.md
  - Development:
      - Developer setup: development/environment.md
      - Roadmap: development/roadmap.md