docs/mkdocs.yml at main · Gthulhu/docs · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
site_name: Gthulhu
site_description: Cloud-native workload optimization scheduler based on Linux Scheduler Extension
site_url: https://gthulhu.org
repo_url: https://github.com/Gthulhu/Gthulhu
edit_uri: https://github.com/Gthulhu/docs/blob/main/docs/

nav:
  - Home: index.md
  - Get Started:
    - Installation: installation.md
    - K8s Deployment: k8s.md
    - Configuring the scheduling policies: gui.md
    - Loading sched_ext schedulers: scx-loader.md
    - Pod-Level Scheduling Metrics: pod-metrics.md
    - Working with multi-node cluster: multi-node.md
    - Debugging with gthulhu-cli: cli.md
    - API Reference: https://pkg.go.dev/github.com/Gthulhu/qumun/goland_core
    - Troubleshooting: faq.md
  - Blog:
    - How It Works: how-it-works.md
    - Improving Network Performance with Custom eBPF-based Schedulers: https://free5gc.org/blog/20250726/index.en/
    - Implementing GTP-driven Automatic Scheduling Optimization with eBPF-based Scheduler: https://free5gc.org/blog/20251126/20251126/
    - Hardening Gthulhu Network Security with Istio Ambient Mode: istio.md
  - Tutorials: https://killercoda.com/gthulhu
  - Demo: https://gthulhu.github.io/Gthulhu/
  - Mentioned: mentioned.md
  - Contributing: contributing.md

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  logo: https://raw.githubusercontent.com/Gthulhu/Gthulhu/main/assets/logo.png
  # favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

plugins:
  - search:
      lang:
        - en
        - zh
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
          nav_translations:
            Home: 首頁
            Get Started: 開始使用
            Installation: 安裝
            K8s Deployment: K8s 部署
            Pod-Level Scheduling Metrics: Pod 級排程指標
            Loading sched_ext schedulers: 載入 sched_ext 排程器
            How It Works: 運作原理
            Project Goals: 專案目標
            Development History: 開發歷史
            API Reference: API 參考
            FAQ: 常見問題
            Demo: Demo 系統
            Mentioned: 相關報導
            Contributing: 貢獻指南
  - mermaid2

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

extra_css:
  - stylesheets/extra.css

extra:
  analytics:
    provider: google
    property: G-T0RWMB3KJM