Hugging Face's logo

Spaces:
wuran
/
mcphub
Sleeping

App Files Community
mcphub
File size: 2,641 Bytes
eb846d0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
---
title: '设置'
description: '了解如何配置您的文档'
---

## 全局配置

所有的全局配置都在项目根目录的 `docs.json` 文件中设置。

### 名称

在配置的顶层设置文档的名称。

```json docs.json
{
  "name": "Mintlify 文档"
}
```

### Logo

您可以显示浅色和深色模式的 logo。

```json docs.json
{
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  }
}
```

### Favicon

```json docs.json
{
  "favicon": "/favicon.ico"
}
```

### 颜色

自定义文档的主色调以匹配您的品牌。

```json docs.json
{
  "colors": {
    "primary": "#9563FF",
    "light": "#AE87FF",
    "dark": "#9563FF"
  }
}
```

<Tip>设置一种颜色系统，通过仅更改主色调来协调您文档的配色方案。</Tip>

### 导航

您的侧边栏导航在 `navigation` 字段中设置。文档页面必须嵌套在组下，组必须嵌套在导航下。

```json docs.json
{
  "navigation": [
    {
      "group": "开始使用",
      "pages": ["introduction", "quickstart", "development"]
    }
  ]
}
```

#### 标签

您可以将页面分组为不同的标签。当您想要将概念或 API 参考组织到不同的部分时，这很有用。

```json docs.json
{
  "navigation": {
    "tabs": [
      {
        "tab": "主要",
        "groups": [
          {
            "group": "开始使用",
            "pages": ["introduction"]
          }
        ]
      },
      {
        "tab": "API 参考",
        "groups": [
          {
            "group": "端点",
            "pages": ["api-reference/users"]
          }
        ]
      }
    ]
  }
}
```

### 页脚

您可以在 `footer` 字段中配置页脚链接。

```json docs.json
{
  "footer": {
    "socials": {
      "website": "https://mintlify.com",
      "github": "https://github.com/mintlify",
      "slack": "https://mintlify.com/community"
    }
  }
}
```

### 搜索

您可以通过多种方式配置搜索，包括替换默认搜索或添加搜索锚点。

```json docs.json
{
  "search": {
    "prompt": "搜索..."
  }
}
```

## 页面配置

页面配置在每个 MDX 文件顶部的 frontmatter 中设置。

### 标题和描述

```md
---
title: '介绍'
description: '欢迎来到我们的产品！'
---
```

### 侧边栏标题

```md
---
sidebarTitle: '主页'
---
```

设置不同于页面标题的侧边栏标题。

### 图标

```md
---
icon: 'star'
---
```

为侧边栏中的页面设置 [FontAwesome](https://fontawesome.com/search?s=solid&m=free) 图标。

### 模式

```md
---
mode: 'wide'
---
```

设置页面的显示模式。选项包括 `"default"` 和 `"wide"`。