VitePress文档

vitepress-docs-site-template — VitePress 文档模板

作者 Otto-J

基于 VitePress 的文档站点模板，可通过 GitHub Actions 自动构建并发布到 GitHub Pages。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

2 个预览视图
桌面端首页1 / 2
桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-13查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

01

基于 VitePress 构建静态文档站点

02

内置 GitHub Actions 工作流，提交后自动发布到 GitHub Pages

03

通过 use template 与 secrets 配置即可完成首次部署

04

README 提供从创建仓库到手动触发工作流的逐步说明

05

采用 MIT 许可，允许修改、商用与分发

模板详细介绍

这是一个用于快速搭建文档网站的 VitePress 模板，仓库作者将其定位为 alpha 阶段，并说明使用前需要具备看懂代码的能力。模板的核心用途是把 docs/ 目录下的 Markdown 内容构建成静态文档站点，并通过仓库内的 GitHub Actions 工作流自动部署到 GitHub Pages，访问地址为「用户名.github.io/仓库名」。

使用流程上，模板要求先通过 use template 创建仓库，再生成 GitHub Personal Access Token，并在仓库的 Actions secrets 中配置 token 与 email 两个密钥，随后手动运行一次 main.yml 工作流完成首次发布。之后克隆仓库、安装依赖、修改 package.json 中的 name、author、repository、homepage 等字段，并持续维护 docs/ 目录内容，后续提交即可触发自动更新。

模板的 README 中列出了尚未完成的 roadmap 项，包括完善自动生成 data.json 的脚本、推广试用以及 gitlab/gitee/coding 支持，说明当前版本主要面向 GitHub Pages 场景。仓库采用 MIT 许可，允许免费使用、修改、商用和分发，但演示图片、字体、图标等第三方素材需单独核对许可。

VitePress文档

适合你的项目吗？

适用场景

  • 为开源项目搭建托管在 GitHub Pages 上的文档站
  • 把已有的 Markdown 文档整理成可浏览的静态网站
  • 需要提交后自动更新文档内容的持续发布流程

适合人群

  • 使用 GitHub 托管代码并希望用 GitHub Pages 发布文档的开发者
  • 熟悉 Markdown 与基本前端构建流程、能自行阅读代码的使用者
  • 需要一份可修改的 VitePress 文档站起点而非成品的项目

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

  1. 1

    通过 use template 创建仓库后，需在 GitHub 生成 Personal Access Token

  2. 2

    在仓库 /settings/secrets/actions 中创建名为 token 和 email 的两个 secret

  3. 3

    到 /actions/workflows/main.yml 手动运行一次工作流完成首次部署

  4. 4

    克隆仓库并安装依赖（pnpm/yarn/npm 任选），修改 package.json 中的 name、author、repository、homepage 等字段

  5. 5

    模板处于 alpha 阶段，README 中 data.json 脚本与 gitlab/gitee/coding 支持尚未完成

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

  • 允许免费使用、修改、商用和分发该版本代码。
  • 分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
  • 代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

  • 演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
  • 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
  • 使用该模板必须自行生成 GitHub Personal Access Token，属于外部账号与凭据要求，非模板自带能力。
  • 必须在仓库 Actions secrets 中配置 token 与 email 两个密钥，否则自动部署流程无法运行。
  • 首次发布需手动触发一次 main.yml 工作流，不能仅靠提交自动完成。
  • 项目处于 alpha 阶段，README 明确要求使用者具备阅读代码的能力，不保证开箱即用。
  • 自动生成 data.json 的脚本尚未完成，相关功能当前不可用。
  • 目前仅支持 GitHub Pages 场景，gitlab/gitee/coding 支持尚未实现。
查看原文依据

Permission is hereby granted, free of charge

许可证原文

准备 token。点击 [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new) 按照截图进行操作

README 原文

设置仓库 street。这一步是把 token 和仓库操作绑定。进入仓库设置 `/settings/secrets/actions`，点击 `New repository secret`。分别创建：

README 原文

回到仓库仓库 `/actions/workflows/main.yml` ，点击 `Run Workflows` 手动运行一次。

README 原文

`alpha` 你需要有看懂代码的能力。

README 原文

- [ ] 完善自动生成 `data.json` 的脚本

README 原文

- [ ] gitlab/gitee/coding 支持

README 原文
https://github.com/Otto-J/vitepress-docs-site-template/blob/main/LICENSEhttps://github.com/Otto-J/vitepress-docs-site-template/blob/main/readme.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-13。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料一般 · 65 / 100
技术栈
VitePress
网站类型
文档
这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2021-11-08
截图检查日期
2026-10-13

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 VitePress。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

审核声明: [email protected] · 2026-10-13

查看当时使用的来源资料

SHA-256: 929721ca45e344e28054e15b678defaa283b9914447bc93769825768f08fb26e

2026-10-13T08:39:48.374Z

来源文件 / 仓库
# vitepress-docs-site-template [![update website](https://github.com/Otto-J/vitepress-docs-site-template/actions/workflows/main.yml/badge.svg?branch=main&event=push)](https://github.com/Otto-J/vitepress-docs-site-template/actions/workflows/main.yml)

> 以下内容请手动删除，仅供参考。

## 背景

很多人希望利用 vitepress 管理文档，并制作一个文档网站，这里提供一个快捷模板，使用该模板可以很快建立起托管到 github pages 上。

## 目前状态

`alpha` 你需要有看懂代码的能力。

## 使用方式

使用本模板会很容易，请按照下面步骤操作：

1. 选择 "use template" 使用本模板，并建立仓库。

![create repo](/docs/assets/create-repo.png)

2. 准备 token。点击 [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new) 按照截图进行操作，名称 Name 和 过期时间 Expiration 可自定义。

![new token](/docs/assets/new-token.png)

3. 点击创建之后，会看到下图，请务必点击第二个圆框处进行自动复制，并将复制到的 token 保存到妥善位置。

![copy token](/docs/assets/copy-token.png)

4. 设置仓库 street。这一步是把 token 和仓库操作绑定。进入仓库设置 `/settings/secrets/actions`，点击 `New repository secret`。分别创建：

- Name: token，Value 刚才复制的 token
- Name: email，Value 输入你的邮箱

5. 回到仓库仓库 `/actions/workflows/main.yml` ，点击 `Run Workflows` 手动运行一次。

6. 如果运行成功。可以访问。`你的用户名.github.io/仓库名` 页面。就看到结果了。

7. 克隆仓库，执行依赖安装，请任意选择 `pnpm/yarn/npm` ，个人推荐 `pnpm` 理由是更轻更快。
8. 修改 `package.json` 中的相关字段，比如 `name` `author` `repository` `homepage` 等
9. 观察并维护 `docs/` 文件夹内容
10. 后续提交 commit 就可以自动维护了。

## roadmap

- [x] 补充 actions 里创建 secrets 的介绍
- [x] 完善 readme.md
- [x] actions 里尽可能使用变量，减少操作步骤
- [ ] 完善自动生成 `data.json` 的脚本
- [ ] 推广试用
- [ ] gitlab/gitee/coding 支持
反馈内容错误

看看同类模板

对比同技术栈与用途的模板，找到更适合的视觉与内容结构。

vitepress-theme-default-plus

vitepress-theme-default-plus

The VitePress Default Theme with a little more POWAH

VitePress · 文档

tf-doc-vault

tf-doc-vault

Shared VitePress tooling for technical and analytical documentation — CLI scaffolder, theme, Confluence import…

VitePress · 文档

carbon-starter

carbon-starter

A template for VitePress Carbon Theme

VitePress · 文档

vitepress-theme-mist-docs

vitepress-theme-mist-docs

vitepress-theme-mist-docs

VitePress · 文档

jekyll-vitepress-theme

jekyll-vitepress-theme

Ruby deserves beautiful documentation. Jekyll VitePress Theme brings VitePress-level polish to Jekyll.

Jekyll · 文档

vitepress-diataxis-template

vitepress-diataxis-template

The full-fledged tech doc template powered by VitePress & Diátaxis framework

Vue · 文档