文档变网站,这款Skill配好导航

用VitePress搭建文档或博客网站。

vitepress 这份 Skill 指导 AI 使用 VitePress 把 Markdown 内容组织成文档网站。你提供文档文件、栏目安排和主题需求,它会检查站点配置与主题目录,再处理路由、导航和页面内容。

文件可以对应页面,Markdown 中也能使用 Vue 组件。对于需要示例交互的技术文档,这意味着说明文字和演示内容可以放在同一篇里,不必所有页面都重新手写界面。

补充的主题指南说明,顶部导航、侧栏和页内目录各有职责。教程与 API 可以配置不同侧栏,让读者进入某个栏目后更容易找到相关内容;还可以选择本地搜索,并配置编辑链接和更新时间展示。

它不会替你决定内容结构。把现有文件堆进网站后,仍要核对导航名称、链接和栏目是否符合阅读顺序。原文基于 VitePress 1.x,具体配置应对照当前项目版本。

适合文档已经散落在仓库里,准备给读者一个统一入口的团队。交付应是可构建检查的文档站与配置;部署到外网是另外一步,不会因为本地构建成功就自动完成。

分类:编程开发

来源仓库:antfu/skills

适合用来做什么

  • 如何使用 VitePress 配置自定义主题?
  • 如何在 VitePress 中集成 Vue 组件到 Markdown 文件?

安装 vitepress

npx skills add https://www.iskills.cc/skills/antfu/skills/vitepress/SKILL.md

在本机终端执行安装命令。安装前请阅读原始说明,确认所需工具、账号和权限。

查看安装步骤 · 查看常见问题

查看 vitepress 的用途与原始说明

浏览全部 Skill 指南