VuePress:Vue驱动的静态网站生成器

分类:工具实测 浏览量:8

摘要:

VuePress是一个基于Vue.js的静态网站生成器,使用Markdown编写内容即可生成带导航、搜索和响应式布局的完整静态网站。它能帮助电商开发或内容团队快速上线结构清晰的文档站或知识库,省去单独搭建前后端工程的麻烦,实现内容与代码分离,并支持将构建产物部署到任意静态托管服务。它特别适合开源项目维护者撰写项目文档、小团队搭建内部知识库,以及个人创建博客或作品集。

VuePress - 基于Vue.js的静态网站生成器,快速搭建文档站和知识库

VuePress:Vue驱动的静态网站生成器,Markdown写网站

开头段

VuePress 是一个基于 Vue.js 的静态网站生成器,官方描述是「极简的 Vue 驱动静态站点生成器」。你用 Markdown 写内容,它负责生成带导航、搜索、响应式布局的完整网站。这个仓库现在有 22722 star,协议是 MIT,创建于 2018-04-05,最近更新是 2026-10-09,由 Vue 作者尤雨溪(Evan You)发起。

用它给项目写文档,能省掉单独搭后端和前端工程的麻烦。你在本地写 .md 文件,它编译成静态 HTML,整个项目就一个 docs 目录,部署时直接扔到任意静态托管或 Nginx 下就行。

适合谁

第一类:开源项目维护者。需要给项目写文档、放 API 说明、维护更新日志。VuePress 默认主题自带目录侧边栏和页面内搜索,写东西用 Markdown,不用碰组件代码。

第二类:小团队内部知识库或技术 wiki。用 Git 管理 .md 文件,成员装好 Node.js 就能本地跑预览,改完推仓库,构建出来就是一个内部站点。

第三类:个人博客或作品集。它支持在 Markdown 里混入 Vue 组件(docs 目录里可以直接放 .vue 文件),想做带点交互的页面(比如放个 demo 演示)也不会被静态生成器限制住。

能解决什么问题

1. 文档站点不用单独开发。 默认主题提供了首页布局、导航栏、侧边栏、搜索、404 页。你不用为了上线一套文档去写前端页面、配路由、做响应式,vuepress dev 一条命令就能本地预览。

2. 内容与代码分离。 文章(Markdown)和站点配置(config.js)分开。写内容的人只管 .md 文件,维护站点结构的人在配置文件里改导航和侧边栏,两边互不干扰。

3. 自带构建产物。 运行 vuepress build 输出纯静态的 HTML/CSS/JS,整个站点就是一个目录,可以扔到任何静态文件服务上,比如 GitHub Pages、Nginx、对象存储,不需要 Node 服务一直开着。

怎么开始用

安装教程

官方 README 给的流程是这样:


# 创建并进入项目目录
mkdir my-docs && cd my-docs

# 初始化 package.json
npm init -y

# 安装 VuePress 本地依赖
npm install -D vuepress

# 创建第一篇文档
mkdir docs && echo '# Hello VuePress' > docs/README.md

# 启动开发服务器(默认端口 8080)
npx vuepress dev docs

构建生产版本:


npx vuepress build docs

构建结果默认输出在 docs/.vuepress/dist,整个目录拷到服务器上就是一个完整站点。注意,VuePress 需要 Node.js 环境,安装前先确认本机有 node 和 npm。

优点和坑

优点:

  • 官方团队维护,项目质量有保障(Vue 作者尤雨溪主导,还有活跃核心团队)。
  • MIT 协议,商用、二次开发都不用担心授权问题。
  • 内容是纯 Markdown,迁移成本低,就算以后不想用它了,.md 文件直接拿到别的静态站生成器(比如 VitePress、Hugo)也能接着用。

坑(都是真实的):

  • v1 已是维护模式。 README 里明确写了「VuePress v1 is now in maintenance mode」,意思是这个版本不再加新功能,只修 bug。想要新功能得看 VitePress 或 VuePress v2+(社区支持)。
  • 定制主题有门槛。 默认主题够用,但你想换皮肤、改布局,得懂 Vue 单文件组件,不是光改配置文件就能搞定。这对只写 Markdown 的人友好,对想深度定制的人不太友好。
  • 构建速度一般。 站点内容多了以后(比如几百个页面),冷启动和热更新会比 Vite 系的工具(比如 VitePress)慢一些,这是它基于 Webpack 的通病。内容少的站无所谓,内容多的站建议优先选 VitePress。
  • 插件生态有历史包袱。 VuePress v1 的很多第三方插件停在旧版本,和新版 npm 依赖可能有兼容问题,装之前最好先看看插件最近有没有维护。

适合你吗

适合:你的目标是快速上线一套结构清晰的文档站或知识库;团队里写内容的人只会 Markdown,不想折腾前端工程;部署环境是普通的静态托管。

不适合:你想要最快的构建速度(选 VitePress);你要做的是营销型官网(需要复杂交互、动画、复杂布局,应该用 Vite/Next 这类);你的站点内容超过几百篇并且需要深度定制主题。

VuePress 算是一个「守成」的工具 —— 它完成了它的使命,现在处于维护期,新项目可以看它的继任者 VitePress,但如果是接手旧项目或者需要 Vue 组件混写的场景,它还能用。

常见问题

VuePress是什么?

VuePress是一个基于Vue.js的静态网站生成器,官方描述是‘极简的Vue驱动静态站点生成器’。它让你用Markdown写内容,然后自动生成带导航、搜索和响应式布局的完整网站。由Vue作者尤雨溪发起,适合快速搭建文档站、知识库或个人博客。

VuePress中文官网在哪里?

VuePress是开源项目,官方文档和仓库都在GitHub上。项目创建于2018-04-05,协议是MIT,由Vue作者尤雨溪发起。你可以搜‘VuePress GitHub’找到它的官方仓库看详细信息和文档。

VuePress 2文档打包缓慢怎么办?

VuePress v1基于Webpack,当站点内容较多(比如几百个页面)时,构建速度会比Vite系的工具(比如VitePress)慢。如果你的站点内容庞大并且追求最快的构建速度,建议优先考虑它的继任者VitePress。

VuePress是免费的吗?

是的,VuePress完全免费且开源。它采用MIT协议,个人使用、商业项目或者二次开发,都不用担心授权问题,可以自由使用和修改。

VuePress和VitePress比哪个好?

VuePress v1已进入维护模式,不再增加新功能。如果你的新项目追求最快的构建速度,或者站点内容超过几百篇,建议选VitePress。VuePress更适合接手旧项目,或者需要把Vue组件混入Markdown的场景。

相关工具推荐

访问 VuePress 官网→

官方地址,点开新窗口;本文仅为工具介绍,与该项目无隶属关系。

微信微博邮箱复制链接