SWECommonBinaryEncodings/mkdocs.yml at main · tipatterson-dev/SWECommonBinaryEncodings · 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
site_name: OGC SWE Common 3.0 — Binary Encodings
site_description: >-
  Binary serialization schemas (Cap'n Proto, FlatBuffers, Protocol Buffers)
  for the OGC SWE Common Data Model 3.0 (OGC 24-014).
site_url: https://tipatterson-dev.github.io/SWECommonBinaryEncodings/
repo_url: https://github.com/tipatterson-dev/SWECommonBinaryEncodings
repo_name: tipatterson-dev/SWECommonBinaryEncodings

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.tabs.link
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mermaid2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tipatterson-dev/SWECommonBinaryEncodings

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Conceptual Guide:
      - Overview: guide/overview.md
      - Basic Types (Pkg 1): guide/basic-types.md
      - Abstract Components (Pkg 2): guide/abstract-components.md
      - Scalar Components (Pkg 3): guide/scalar-components.md
      - Range Components (Pkg 4): guide/range-components.md
      - Polymorphic Unions (Pkg 5): guide/unions.md
      - Records & Vectors (Pkg 6): guide/records-vectors.md
      - Choice Components (Pkg 7): guide/choice.md
      - Arrays & Streams (Pkg 8): guide/arrays-streams.md
      - Geometry (Pkg 9): guide/geometry.md
      - Encodings (Pkg 10): guide/encodings.md
  - Encoding Comparison: comparison.md
  - Reference:
      - Type Reference: reference/types.md
      - Design Decisions: reference/design-decisions.md
  - Architecture: architecture.md