PeerCache/mkdocs.yml at main · flymysql/PeerCache · 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: PeerCache
site_description: Peer-to-peer RDMA zero-copy L3 KV-cache backend for SGLang HiCache
site_url: https://flymysql.github.io/PeerCache/
repo_url: https://github.com/flymysql/PeerCache
repo_name: flymysql/PeerCache
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - content.code.copy
    - content.code.annotate
    - toc.follow

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Multi-node Demo: demo-multinode.md
  - Positioning & Comparison: positioning.md
  - Architecture: architecture.md
  - Slotmap Mode: slotmap.md
  - SDK Reference: sdk.md
  - Benchmarks: benchmarks.md
  - Performance Baseline: performance.md
  - Changelog: changelog.md

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

plugins:
  - search
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 首页
            Getting Started: 快速开始
            Multi-node Demo: 多机示例
            Positioning & Comparison: 定位与对比
            Architecture: 架构
            SDK Reference: SDK 参考
            Benchmarks: 性能基准测试
            Performance Baseline: 性能基线
            Changelog: 更新日志

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/flymysql/PeerCache