Vue文档

my-docs-website — Vue 文档模板

作者 johnbeech

基于 VuePress 的 Markdown 文档站点模板，支持在 Markdown 中嵌入 Vue 组件，并按文件夹结构自动生成侧边栏，通过 GitHub Actions 部署到 GitHub Pages。

打开源站下载源码 ZIP

看看你的网站会是什么样

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

1 个预览视图
作者提供的预览
作者提供的预览首屏预览

来自项目 README 的原始预览。

目前有 1 张原始预览，可打开完整图片查看设计细节。

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

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

值得关注的模板亮点

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

01

Markdown 驱动内容，侧边栏按嵌套文件夹结构自动生成

02

Vue 组件可在站点根目录任意位置开发并嵌入 Markdown

03

通过 GitHub Actions 自动部署到 GitHub Pages

04

内置 Mocha 测试、代码检查，并在 PR 上运行测试

05

VuePress 提供开发时的热重载

模板详细介绍

这是一个自托管的文档站点模板，构建在 VuePress 之上，仓库说明中标注为 vuesite 模板的副本。站点内容以 Markdown 驱动，同时把交互式 Vue 组件作为一等公民：组件可以放在站点根目录的任意位置开发，再嵌入到 Markdown 中使用。侧边栏根据嵌套的文件夹结构自动生成，无需手工维护导航。

托管方面，模板设计为通过 GitHub Pages 发布，并由 GitHub Actions 自动部署；按说明正确配置后，站点可访问在 johnbeech.github.io/my-docs-website/ 路径下。开发支持包括 VuePress 提供的热重载、内置的 Mocha 测试框架、作为测试一部分的代码检查，以及在 PR 上通过 GitHub Actions 运行测试。

使用前需要本地安装 Node LTS，通过 GitHub 的模板生成功能复制仓库、检出代码，然后运行 npm install 与 node first-time-setup.js，并在仓库的 Pages 设置中启用从 gh-pages 分支发布。仓库采用 ISC 许可，允许为任何目的免费使用、复制、修改和分发，包括商用，但需保留版权与许可声明；站点打包的 Font Awesome、VuePress 相关包、axios、time-until 等依赖，以及构建工具链中的 md2json、capture-website-cli、eslint 系列、mocha 等，各自适用其自身条款。仓库未提供样式、性能或生产就绪程度的说明。

Vue文档

适合你的项目吗？

适用场景

  • 为开源项目搭建带自动侧边栏的文档站点
  • 在文档页面中嵌入可交互的 Vue 组件示例
  • 用 GitHub Pages 与 GitHub Actions 托管并自动发布文档

适合人群

  • 熟悉 Vue 与 Markdown、希望自托管文档站点的开发者
  • 需要文档与交互式组件混合呈现的项目
  • 使用 GitHub 仓库并通过 Actions 发布站点的团队

上手与定制指南

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

  1. 1

    本地安装 Node LTS

  2. 2

    在 GitHub 上使用模板生成仓库并检出代码

  3. 3

    依次运行 npm install 与 node first-time-setup.js

  4. 4

    在仓库 Settings > Pages 中启用从 gh-pages 分支发布

  5. 5

    第三方依赖与素材需按各自许可单独核对

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

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

使用时需要遵守

  • 允许为任何目的免费使用、复制、修改和分发，包括商用。
  • 所有副本均需保留原版权声明和许可声明。
  • 代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

  • 站点打包的 Font Awesome、VuePress 相关包、axios、time-until 等运行时依赖，以及构建工具链中的 md2json、capture-website-cli、eslint 系列、mocha 等，各自适用其自身许可条款，需单独核对，不随本仓库的 ISC 许可一并授予。
  • 发布站点需使用 GitHub 账户并在仓库 Settings > Pages 中手动启用从 gh-pages 分支发布，属于外部平台账户与配置要求。
  • 托管与自动部署依赖 GitHub Pages 和 GitHub Actions 这两项外部服务，需在 GitHub 上使用。
  • 演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 ISC 许可判断。
  • 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
查看原文依据

for any purpose with or without fee is hereby granted

许可证原文

Which come with their own terms and conditions.

README 原文

Go to [Github > Settings > Pages](https://github.com/johnbeech/my-docs-website/settings/pages) and enable publishing from the `gh-pages` branch

README 原文

Hosted via GitHub pages - Deployed automatically via GitHub Actions

README 原文
https://github.com/johnbeech/my-docs-website/blob/main/LICENSE.mdhttps://github.com/johnbeech/my-docs-website/blob/main/README.md

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

项目核对记录与介绍依据

模板资料

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

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

这个项目需要核对什么

记录的仓库更新时间
2022-01-28
截图检查日期
2026-10-02

目前没有记录演示链接。请依据仓库说明在本地评估；仅凭截图无法确认交互行为。

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

查看具体选型方法 →

介绍的制作与核对状态

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

已完成服务器许可规则与 AI 来源核对；未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: db7578ea63eb0f6903494be7a8bf2054b7f9a7c6c1bce0cdf5f99c42c71ccda7

2026-10-02T08:54:56.586Z

来源文件 / 仓库
# Your new Vuesite!

A self hosted toolset for building interactive websites on top of Vuepress.

![Preview of website - site name navigation, sidebar, front page content](./screenshot.png)

## Features

- Markdown driven website
- Interactive Vue components as first class citizen
- Auto-generated sidebar based on nested folder structure
- New components can be developed anywhere in the site root; and embedded into Markdown

## Hosting

- Hosted via GitHub pages
- Deployed automatically via GitHub Actions

If setup correctly (see below); you should be able to access this site on:
- https://johnbeech.github.io/my-docs-website/

## Development Support

- Hot-reloading provided by Vuepress
- Mocha test framework included
- Linting included as part of tests
- Testing on PRs via Github Actions

## How to get started

- Make sure you have the latest version [Node LTS](https://nodejs.org/en/) installed
- Copy [this template in GitHub](https://github.com/johnbeech/my-docs-website/generate)
- Check out the code locally
- Run: `npm install`
- Run: `node first-time-setup.js`
- Go to [Github > Settings > Pages](https://github.com/johnbeech/my-docs-website/settings/pages) and enable publishing from the `gh-pages` branch

## Licenses

See: [LICENSE.md](./LICENSE.md)

The hosted vuesite packages together:

- @fortawesome/fontawesome-svg-core
- @fortawesome/free-solid-svg-icons
- @fortawesome/vue-fontawesome
- @vuepress/plugin-register-components
- @vuepress/theme-default
- axios
- time-until
- vuepress

Whilst the build tools require:

- @connected-web/md2json
- capture-website-cli
- chai
- eslint
- eslint-plugin-html
- eslint-plugin-mocha
- eslint-plugin-vue
- mocha
- node-localstorage
- promise-path
- standard


Which come with their own terms and conditions.
反馈内容错误

看看同类模板

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

vitepress-diataxis-template

vitepress-diataxis-template

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

Vue · 文档

vitepress-marketing

vitepress-marketing

VitePress set up as a real marketing site, not a docs site: a home page, a blog, and a working contact form.

Vue · 博客

docs-theme

docs-theme

A modern documentation theme for VitePress

Vue · 文档

shadcn-docs-nuxt

shadcn-docs-nuxt

Effortless and beautiful docs template built with Nuxt Content & shadcn-vue.

Nuxt · 文档

docs

docs

Nuxt Docs Template made with Nuxt UI and Nuxt Content.

Nuxt · 文档

shadcn-nuxt-starter

shadcn-nuxt-starter

⚡️ Starter built with Nuxt 3 + Shadcn-ui + UnoCSS + TypeScript.

Nuxt · 后台