Skip to content

创建 VitePress 项目

本项目已经按 VitePress 的根目录模式配置,Markdown 页面直接放在仓库根目录下,VitePress 配置位于 .vitepress/config.mts

关键配置

titledescription 控制站点标题和元信息:

ts
export default defineConfig({
  lang: 'zh-CN',
  title: 'HideApps Docs',
  description: 'VitePress + Cloudflare Pages 部署教程'
})

生产域名用于 Sitemap:

ts
sitemap: {
  hostname: 'https://docs.hideapps.top'
}

开启本地搜索:

ts
search: {
  provider: 'local'
}

编写页面

新增页面时,直接在 guide/reference/ 下创建 Markdown 文件,再把页面加入 .vitepress/config.mtssidebar

推荐页面命名:

text
guide/new-topic.md
reference/new-reference.md

静态文件

需要原样复制到构建产物的文件放在 public/。例如:

  • public/favicon.svg
  • public/_headers

Cloudflare Pages 会从 .vitepress/dist 读取最终构建产物,因此 public/_headers 会被复制为 .vitepress/dist/_headers

基于 VitePress 和 Cloudflare Pages 构建。