eos/mkdocs.yml at master · embeddedos-org/eos · 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: EoS Documentation
site_description: Next-generation embedded OS build system
site_url: https://eos.dev

repo_name: eos
repo_url: https://github.com/example/eos

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

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Architecture: architecture.md
  - User Guide:
    - Build: guide/build.md
    - System: guide/system.md
    - Firmware: guide/firmware.md
    - Hybrid: guide/hybrid.md
    - Layers: guide/layers.md
  - Configuration:
    - eos.yaml Schema: config/schema.md
    - Toolchains: config/toolchains.md
    - Boards: config/boards.md
  - API Reference:
    - Core Types: api/types.md
    - Config: api/config.md
    - Graph: api/graph.md
    - Backends: api/backends.md
    - System: api/system.md
    - Firmware: api/firmware.md
  - Examples:
    - Linux Image: examples/linux.md
    - RTOS Firmware: examples/rtos.md
    - Hybrid System: examples/hybrid.md

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

plugins:
  - search
  - minify:
      minify_html: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/example/eos