4ward/mkdocs.yml at main · 4ward-p4/4ward · 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
site_name: 4ward
site_description: Glass-box P4 simulator — trace every decision your packet makes.
site_url: https://4ward-p4.github.io/4ward/
repo_url: https://github.com/4ward-p4/4ward
repo_name: 4ward-p4/4ward
edit_uri: edit/main/userdocs/

docs_dir: userdocs
site_dir: site
exclude_docs: README.md

plugins:
  - search
  - glightbox
  - meta
  - macros

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/4ward-p4/4ward

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.png
  custom_dir: userdocs/overrides
  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.expand
    - navigation.top
    - content.code.copy
    - search.highlight

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Web Playground:
      - Getting Started: getting-started/playground.md
      - Reference: reference/playground.md
  - CLI:
      - Getting Started: getting-started/cli.md
      - Reference: reference/cli.md
      - STF Test Format: reference/stf.md
  - gRPC API:
      - Getting Started: getting-started/grpc.md
      - Reference: reference/grpc.md
  - C++ Library:
      - Getting Started: reference/embedding-cc.md
      - Dataplane Matchers: reference/dataplane-matchers.md
  - Concepts:
      - Trace Trees: concepts/traces.md
      - Type Translation: concepts/type-translation.md
      - P4Runtime Features: concepts/p4runtime-features.md
      - Architectures: concepts/architectures.md
      - Error Messages: reference/errors.md
      - Architecture Modifications: concepts/architecture-modifications.md
  - Examples: examples.md