novastor/mkdocs.yml at main · azrtydxb/novastor · 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
site_name: NovaStor
site_description: Unified Kubernetes-Native Storage — Block, File, and Object
site_url: https://azrtydxb.github.io/novastor
repo_url: https://github.com/azrtydxb/novastor
repo_name: azrtydxb/novastor

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.follow

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true

markdown_extensions:
  - 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
  - pymdownx.details
  - admonition
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Architecture:
      - Overview: architecture/overview.md
      - Component Details: architecture/components.md
      - SPDK Data Plane: architecture/spdk-dataplane.md
  - Deployment:
      - Quick Start: deployment/quickstart.md
      - File & S3 Gateway Deployment: deployment/gateway-deployment.md
      - Helm Chart Reference: deployment/helm-values.md
      - RBAC Configuration: deployment/rbac.md
  - Operations:
      - Monitoring: operations/monitoring.md
      - Failure Recovery: operations/recovery.md
      - Encryption at Rest: operations/encryption.md
  - API Reference:
      - CRD Reference: api/crds.md
      - S3 API Compatibility: api/s3.md
  - Development:
      - Contributing: development/contributing.md
      - Testing: development/testing.md