Skip to content

Commit da83300

Browse files
committed
docs: add vitepress plugins and update getting started guide
1 parent 5a2a685 commit da83300

File tree

6 files changed

+727
-11
lines changed

6 files changed

+727
-11
lines changed

docs/.vitepress/config.ts

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
import { defineConfig } from 'vitepress'
2+
import llmstxt from 'vitepress-plugin-llms'
3+
import { groupIconMdPlugin, groupIconVitePlugin } from 'vitepress-plugin-group-icons'
24
import pkg from '../../packages/create-mcp-kit/package.json' with { type: 'json' }
35

46
// https://vitepress.dev/reference/site-config
@@ -7,6 +9,7 @@ export default defineConfig({
79
description: 'A CLI tool to create MCP (Model Context Protocol) applications with ease',
810
rewrites: {
911
'en/:rest*': ':rest*',
12+
'en/index.md': 'index.md',
1013
},
1114
base: '/mcp-kit/',
1215
head: [
@@ -57,4 +60,53 @@ export default defineConfig({
5760
},
5861
},
5962
},
63+
markdown: {
64+
config(md) {
65+
md.use(groupIconMdPlugin)
66+
},
67+
},
68+
vite: {
69+
plugins: [
70+
llmstxt({
71+
ignoreFiles: ['en/index.md', 'zh/index.md'],
72+
description: 'A CLI tool to create MCP applications with ease',
73+
sidebar: [
74+
{
75+
text: 'Introduction',
76+
base: '',
77+
items: [
78+
{ text: 'What is MCP?', link: '/en/guide/what-is-mcp' },
79+
{ text: 'What is MCP Kit?', link: '/en/guide/what-is-mcp-kit' },
80+
{ text: 'Getting Started', link: '/en/guide/getting-started' },
81+
],
82+
},
83+
{
84+
text: '简介',
85+
base: '',
86+
items: [
87+
{ text: '什么是MCP?', link: '/zh/guide/what-is-mcp' },
88+
{ text: '什么是MCP Kit?', link: '/zh/guide/what-is-mcp-kit' },
89+
{ text: '快速开始', link: '/zh/guide/getting-started' },
90+
],
91+
},
92+
],
93+
details: `\
94+
- 🚀 Quick Scaffolding
95+
- 📦️ TypeScript First
96+
- 🛠️️ Development Tools
97+
- 🔧 Configurable Templates
98+
- 🌐️ Multiple Transport Modes
99+
- 📚️ Comprehensive APIs
100+
101+
MCP Kit is a toolkit for creating MCP (Model Context Protocol) applications with ease, enabling developers to build MCP-compliant servers and client applications. It consists of two major parts:
102+
103+
- A scaffolding system that quickly generates MCP server and client projects with [pre-configured TypeScript setup](https://my-mcp-hub.github.io/mcp-kit/guide/what-is-mcp-kit.html) and built-in developer tools for rapid development.
104+
105+
- Project templates that provide standardized structure for both [MCP servers and clients](https://my-mcp-hub.github.io/mcp-kit/guide/what-is-mcp.html), pre-configured to follow Model Context Protocol specifications.
106+
107+
In addition, MCP Kit streamlines the development workflow with [getting started guides](https://my-mcp-hub.github.io/mcp-kit/guide/getting-started.html) and best practices with full TypeScript support.`,
108+
}),
109+
groupIconVitePlugin(),
110+
],
111+
},
60112
})

docs/.vitepress/theme/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import DefaultTheme from 'vitepress/theme'
2+
import 'virtual:group-icons.css'
23
import '../styles/custom.css'
34

45
export default {

docs/en/guide/getting-started.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,19 @@ $ npm create mcp-kit@latest
1919
```
2020

2121
```sh [pnpm]
22-
$ pnpm create mcp-kit@latest
22+
$ pnpm create mcp-kit
2323
```
2424

2525
```sh [yarn]
26-
$ yarn create mcp-kit@latest
26+
$ yarn create mcp-kit
27+
```
28+
29+
```bash [bun]
30+
$ bun create mcp-kit
31+
```
32+
33+
```bash [deno]
34+
$ deno init --npm mcp-kit
2735
```
2836
:::
2937

docs/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@
1212
"keywords": [],
1313
"author": "zhensherlock",
1414
"license": "MIT",
15-
"dependencies": {},
1615
"devDependencies": {
17-
"vitepress": "^2.0.0-alpha.12"
16+
"vitepress": "^2.0.0-alpha.12",
17+
"vitepress-plugin-group-icons": "^1.6.3",
18+
"vitepress-plugin-llms": "^1.7.4"
1819
}
1920
}

docs/zh/guide/getting-started.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,19 @@ $ npm create mcp-kit@latest
1919
```
2020

2121
```sh [pnpm]
22-
$ pnpm create mcp-kit@latest
22+
$ pnpm create mcp-kit
2323
```
2424

2525
```sh [yarn]
26-
$ yarn create mcp-kit@latest
26+
$ yarn create mcp-kit
27+
```
28+
29+
```bash [bun]
30+
$ bun create mcp-kit
31+
```
32+
33+
```bash [deno]
34+
$ deno init --npm mcp-kit
2735
```
2836
:::
2937

0 commit comments

Comments
 (0)