phaemos/mkdocs.yml at main · zaccesss/phaemos · 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
site_name: Phaemos
site_description: Industrial IoT predictive maintenance platform - documentation
site_url: https://docs.phaemos.com
repo_url: https://github.com/zaccesss/phaemos
repo_name: zaccesss/phaemos
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    scheme: slate
    primary: indigo
    accent: indigo
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/zaccesss/phaemos
      name: Phaemos on GitHub
    - icon: fontawesome/brands/patreon
      link: https://www.patreon.com/c/zaccesss
      name: Support on Patreon

docs_dir: docs

nav:
  - Home: index.md
  - Getting Started:
    - Architecture: architecture.md
    - Deployment: deployment.md
    - Deployment Checklist: deployment-checklist.md
    - Scalability: scalability.md
  - Reference:
    - API Reference: api-reference.md
    - Sensor Reference: sensor_reference.md
    - Database Schema: schema.md
  - Security: security.md
  - Development:
    - Decision Log: decisions.md
    - Week by Week: week_by_week.md
    - Verification: VERIFICATION.md
  - Monitoring: instatus.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true