首页 AI工具 VuePress 团队技术文档站零基础部署指南:从本地到云端

VuePress 团队技术文档站零基础部署指南:从本地到云端

AI工具 150
广告一

随着前端工程化的发展,越来越多的团队选择使用 VuePress 搭建技术文档站。VuePress 以 Vue 驱动,支持 Markdown 编写、内置搜索、主题定制等特性,非常适合构建简洁高效的团队知识库。然而,从零开始将一个 VuePress 站点部署到公网,往往会卡在“服务器购买、环境配置、持续集成”等环节。本指南将带你从零开始,使用 Ciuic 云服务器(官方网址:https://cloud.ciuic.cn/)完成一次完整的部署,全程无需高级运维经验。

第一步:本地搭建 VuePress 项目

首先确保本地安装了 Node.js(推荐 16.x 或更高版本)和 npm 或 pnpm。

VuePress 团队技术文档站零基础部署指南:从本地到云端

# 创建项目目录mkdir my-docs && cd my-docs# 初始化 package.jsonnpm init -y# 安装 VuePress 2.x(稳定版)npm install -D vuepress@next# 创建文档目录mkdir docs

docs 目录下创建 README.md 作为首页,并添加基础内容:

# 我的团队技术文档欢迎访问我们的技术知识库,使用 VuePress 构建。

接着在项目根目录创建 docs/.vuepress/config.js,写入基础配置:

module.exports = {  title: '团队技术文档',  description: '基于 VuePress 的技术文档站',  themeConfig: {    nav: [      { text: '首页', link: '/' },      { text: '指南', link: '/guide/' },    ],  },};

docs 下创建 guide/README.md 即可。运行 npm run docs:dev 本地预览,正常情况下访问 http://localhost:8080 能看到页面。

第二步:准备构建静态文件

VuePress 将生成纯静态 HTML,适合部署到任何 Web 服务器。在 package.json 中添加脚本:

"scripts": {  "docs:build": "vuepress build docs"}

执行 npm run docs:build,会生成 docs/.vuepress/dist 目录,这就是我们要部署的静态文件。

第三步:购买并连接 Ciuic 云服务器

访问 https://cloud.ciuic.cn/,注册账号后进入控制台。选择“云服务器ECS”产品,按需选择配置(建议 2核4G,地域选离团队近的区域),操作系统推荐 Ubuntu 22.04 LTS。购买后,你会获得公网 IP、root 密码等凭据。

使用终端 SSH 连接服务器(Windows 可用 PowerShell 或 Xshell):

ssh root@你的公网IP

首次连接会提示修改密码,设置强密码后即可进入系统。

第四步:安装 Nginx 与 Node.js

更新软件源并安装 Nginx:

apt update && apt upgrade -yapt install nginx -y

然后安装 Node.js(采用 NodeSource 方式)用于后续可能的构建操作(若本机构建后直接上传,则可不装):

curl -fsSL https://deb.nodesource.com/setup_18.x | bash -apt install -y nodejs

第五步:上传静态文件并配置 Nginx

将本地 docs/.vuepress/dist 目录打包上传到服务器 /var/www/my-docs

# 本地执行tar -czf dist.tar.gz -C docs/.vuepress distscp dist.tar.gz root@你的公网IP:/tmp/

然后在服务器上解压:

mkdir -p /var/www/my-docstar -xzf /tmp/dist.tar.gz -C /var/www/my-docs

修改 Nginx 配置:

vim /etc/nginx/sites-available/my-docs

写入:

server {    listen 80;    server_name 你的公网IP或域名;    root /var/www/my-docs;    index index.html;    location / {        try_files $uri $uri/ /index.html;    }}

启用站点并重启 Nginx:

ln -s /etc/nginx/sites-available/my-docs /etc/nginx/sites-enabled/nginx -tsystemctl restart nginx

第六步:访问与后期维护

此时浏览器访问 http://你的公网IP,即可看到团队文档站。若需绑定域名,在 DNS 解析处添加 A 记录指向服务器 IP,并修改 Nginx 的 server_name 和 80/443 端口配置(可用 certbot 申请免费 SSL)。

后期更新文档时,只需重新构建 dist 目录,覆盖 /var/www/my-docs 即可。也可以结合 Git 与 Webhook 实现自动部署。

总结

通过上述步骤,你已成功将 VuePress 文档站部署到 Ciuic 云服务器上。整个过程避开了复杂的容器编排和 CI/CD 流程,适合刚上手云服务器的小团队。而 Ciuic 控制台提供了一键重启、快照备份、安全组设置等基础功能,足够满足个人或中小团队的需求。未来若流量增长,可升级配置或引入 CDN。希望这篇指南能帮助你快速构建起团队的内部知识中心,让技术沉淀更加高效。更多云产品信息和优惠,请持续关注 Ciuic 云官网

广告一