brosdk-docs/mkdocs.yml at main · browsersdk/brosdk-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
118
119
# MkDocs configuration for BroSDK Documentation

site_name: BroSDK 文档
site_description: BroSDK 浏览器环境管理文档
site_url: https://www.brosdk.com/docs/
site_author: BroSDK Team

# Repository
repo_name: browsersdk/brosdk-docs
repo_url: https://github.com/browsersdk/brosdk-docs

# Copyright
copyright: Copyright &copy; 2026 BroSDK Team

# Theme
theme:
  name: material
  language: zh
  favicon: assets/images/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
    - toc.follow
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: fontawesome/solid/fingerprint

# Plugins
plugins:
  - search
  - mermaid2

extra_javascript:
  - assets/javascripts/baidu-analytics.js

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - attr_list
  - md_in_html
  - footnotes

# Navigation structure
nav:
  - 首页: index.md
  - 快速开始: quick-start.md
  - 用户指南:
    - APP 配置: user-guide/app-config.md
    - 环境管理: user-guide/environment.md
    - 启动参数与 CDP: user-guide/browser-launch.md
  - 集成指南:
    - MCP 使用指南: integration/mcp.md
    - SDK 回调机制: integration/callback.md
    - C 语言集成: integration/c-native.md
    - Rust 集成: integration/rust.md
    - TypeScript 集成: integration/typescript.md
  - SDK 参考: sdk-reference.md
  - 服务端 API: api/server.md
  - 故障排除: troubleshooting.md
  - 部署指南: deployment.md

# Additional settings
extra:
  generator: false  # Hide "Made with Material for MkDocs"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/browsersdk/brosdk-docs
    - icon: fontawesome/solid/globe
      link: https://www.brosdk.com
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: Thanks for feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: Thanks for feedback!