mcpField
V
vitepress

vitepress

github.com/antfu开发6.0k11.9k 次安装6 天前更新
代码仓库

关于 vitepress

面向 VitePress 项目的技能,帮助使用 Vite 和 Vue 3 将 Markdown 内容构建为静态站点。涵盖文档、博客和营销站点所需的路由、主题、搜索与部署配置。

主要功能

  1. 01基于 Markdown 的文件路由
  2. 02在 Markdown 中使用 Vue 组件
  3. 03代码块高亮与内容加载
  4. 04主题配置和自定义
  5. 05多语言站点支持
  6. 06静态站点部署指导

适用场景

  1. 01构建产品文档站点
  2. 02创建 Markdown 博客
  3. 03定制站点导航、侧栏和主题
  4. 04配置多语言站点与部署

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/antfu/skills --skill vitepress

安装后在 Claude Code 中输入/vitepress确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

GENERATION.md
references/
advanced-i18n.md
advanced-ssr.md
core-cli.md
core-config.md
core-markdown.md
core-routing.md
features-code-blocks.md
features-data-loading.md
features-dynamic-routes.md
features-vue.md
recipes-deploy.md
theme-config.md
theme-custom.md
theme-customization.md

详细介绍

VitePress 是一个基于 Vite 和 Vue 3 构建的静态站点生成器(SSG)。它接收 Markdown 内容,应用主题,并生成静态 HTML,这些 HTML 会成为支持快速导航的 SPA。非常适合文档、博客和营销网站。

主要特性:

  • 基于文件的路由,使用 .md 文件
  • 可直接在 Markdown 中使用 Vue 组件
  • 快速 HMR,即时更新(<100ms)
  • 针对文档优化的默认主题
  • 内置搜索(本地或 Algolia)

使用 VitePress 项目之前:

  • 检查 .vitepress/config.ts 中的站点配置
  • 查看 .vitepress/theme/ 中的自定义主题扩展
  • public/ 目录包含原样提供的静态资源

此技能基于 VitePress 2.0.0-alpha.20,于 2026-09-25 生成。

VitePress 2 说明(v1 → v2): 使用 vitepress@next 安装;要求 Node.js 22+。defineConfigWithTheme 已弃用,请改用 defineConfig<ThemeConfig>。原生 RTL 支持(dir 选项、CSS 逻辑属性)取代了旧的 PostCSS 插件方案。新增内置 iconify 流程(icons 配置、useIcon/VPIcon、collection:name 社交图标)。新增 assetsBase(CDN)和 assetsShards 构建选项;移除了 metaChunk。Markdown 的 image.lazyLoading 更名为 image.lazyLoad。

核心

主题描述参考
配置配置文件设置、defineConfig、站点元数据core-config
CLI命令行界面:dev、build、preview、initcore-cli
路由基于文件的路由、源目录、重写规则core-routing
MarkdownFrontmatter、容器、表格、锚点、包含内容core-markdown

功能

代码与内容
主题描述参考
代码块语法高亮、行高亮、差异、聚焦features-code-blocks
Markdown 中的 Vue组件、script setup、指令、模板features-vue
数据加载构建时数据加载器、createContentLoaderfeatures-data-loading
动态路由根据数据生成页面、路径加载器文件features-dynamic-routes

主题

主题描述参考
主题配置导航、侧边栏、搜索、社交链接、页脚theme-config
自定义CSS 变量、插槽、字体、全局组件theme-customization
自定义主题从头构建主题、主题接口theme-custom

高级

主题描述参考
国际化多语言站点、区域配置advanced-i18n
SSR 兼容性服务端渲染、ClientOnly、动态导入advanced-ssr

配方

主题描述参考
部署GitHub Pages、Netlify、Vercel、Cloudflare、Nginxrecipes-deploy

评论

支持 Markdown