EIMS/mkdocs.yml at main · Ratthabhumi/EIMS · 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
site_name: EIMS Engineering Handbook
site_description: Enterprise Infrastructure Management System (EIMS) authoritative single source of truth for architecture, design, and operations.
site_author: EIMS Engineering Team
repo_name: eims-project
repo_url: https://github.com/enterprise/eims

theme:
  name: material
  logo: assets/icons/eims-logo.png
  favicon: assets/icons/favicon.ico
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: slate
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: slate
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

nav:
  - Handbook Home: index.md
  - Master Plan: 01_EIMS_MASTER_PLAN.md
  - Product Requirements: 02_PRODUCT_REQUIREMENTS_DOCUMENT.md
  - Architecture:
    - Overview: 03_SOFTWARE_ARCHITECTURE_DOCUMENT.md
    - System Blueprint: SYSTEM_BLUEPRINT.md
    - Guidelines: ENGINEERING_GUIDELINES.md
    - Decisions (ADR): adr/index.md
  - Database Design: 04_DATABASE_DESIGN.md
  - API Specifications: 05_API_SPECIFICATION.md
  - Security Architecture: SECURITY.md
  - Deployment & Operations: DEPLOYMENT.md
  - Testing Framework: TESTING.md
  - Documentation System (EDS):
    - Document Template: _templates/document-template.md
    - Document Standard: _style/document-standard.md
    - Writing Guide: _style/writing-guide.md
    - Terminology: _style/terminology.md
    - Diagram Standard: _style/diagram-standard.md

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      title: On this page
  - 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
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

plugins:
  - search

extra:
  version:
    provider: mike