-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
86 lines (78 loc) · 2.82 KB
/
mkdocs.yml
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
site_name: 'SECU4 Off Car Systems'
site_description: 'Documentation for SECU4 Off Car Systems'
docs_dir: 'docs'
repo_url: https://github.com/mat-docs/SECU4.Site
site_url: https://atlas.mclarenapplied.com/secu4/
theme:
name: 'material'
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: 'teal'
accent: 'indigo'
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: 'teal'
accent: 'indigo'
toggle:
icon: material/brightness-4
name: Switch to light mode
custom_dir: 'overrides'
# assets/swoosh* is cached aggressively - rename if icons change
favicon: 'assets/swoosh-black/favicon.png'
logo: 'assets/swoosh-black/logo.png'
icon:
repo: fontawesome/brands/github
features:
- navigation.tabs
- toc.integrate
copyright: Copyright © 2024 McLaren Applied Ltd.
nav:
- ⇱ Docs Portal: https://atlas.mclarenapplied.com/
- Overview: index.md
- Configuration Api:
- Overview: configuration_api/index.md
- Protobuf: https://github.com/mat-docs/System.Monitor.Configuration.API.Client.Sample/tree/main/Protos
- Example: https://github.com/mat-docs/System.Monitor.Configuration.API.Client.Sample/tree/main
- Protocol Documentation: configuration_api/docs.md
- Open Streaming Architecture:
- Overview: open_streaming_architecture/index.md
- Bridge Service: open_streaming_architecture/bridge_service/index.md
- Stream API:
- Overview: open_streaming_architecture/stream_api/index.md
- Stream API Client: open_streaming_architecture/stream_api/stream_client.md
- Stream API Server: open_streaming_architecture/stream_api/stream_server.md
- Key Generator Service: open_streaming_architecture/stream_api/key_generator.md
- Sample Code: https://github.com/mat-docs/MA.Streaming.Api.UsageSample
- Protocol Documentation: open_streaming_architecture/docs.md
- Open Source Repositories: https://github.com/Software-Products
- Support: support.md
markdown_extensions:
- abbr
- admonition
- attr_list
- codehilite
- def_list
- footnotes
- toc:
permalink: "#"
- meta
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets:
base_path: docs
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true