一键部署！这样搭建一个文档网站真的很简单！

最新推荐文章于 2024-01-13 10:00:00 发布

前端瓶子君

最新推荐文章于 2024-01-13 10:00:00 发布

阅读量424

点赞数 1

文章标签： java web javascript nginx html

原文链接：https://juejin.cn/post/6939690218421223438

版权

点击上方前端瓶子君，关注公众号

回复算法，加入前端编程面试算法每日一题群

前言

最近笔者在复习 JavaScript 基础知识，刚看完《JavaScript 高级程序设计（第四版）》，想再找一些优秀代码库巩固一下学到的内容，自然而然的就想到了 Lodash。

此库在笔者公司使用率极高，因此想深入研究下源码并输出系列分析文章。而线上大多源码分析大多都是自己搭建的文档网站，于是就到了这篇文章的主题，快速搭建一个文档网站。

其实笔者是有一个服务器的，域名是 https://lcs.show，但是服务器确实带宽有限，再加上还得自己配置 NGINX、GitHub Action 以及 https 证书等内容。

很巧看到了腾讯云 cloudbase 服务，可以快速搭建静态网站，如果你没有域名的话会自动分配一个域名（但是会比较难记），可以的话还是自己注册一个域名，也可以很方便地申请并配置 https 证书，如果搭配 GitHub Action 使用的话可以说是完全不用考虑服务器维护的内容了。

接下来就来讲一下如何搭建以及部署。

搭建及部署

本文是以 VuePress 为例进行搭建部署，VitePress、Next、Docsify 等部署大同小异。

项目初始化

安装 CLI

npm install -g @cloudbase/cli@latest

初始化一个应用

tcb new cloudbase-test vuepress

使用该 CLI 是需要进行登录的，如果 CLI 检测到你当前没有登录的话会自动打开浏览器跳转到腾讯云登录页面，登录成功后返回命令行，继续下一步操作：

接下来选择你认为合适的一个服务器地点，在这里我选择上海。

image.png

接下来会选择关联环境，如果你当前没有环境的话可直接选择「创建新环境」，CLI 会自动打开浏览器跳转到「创建新环境」页面，创建新环境如下图，在这里我选择使用 VuePress 模板进行创建：

image.png

选择完成后点击下一步即可：

image.png

创建成功后返回命令行，会显示正在初始化环境，稍等几分钟就可以直接创建项目。创建成功后会生成以下目录结构的项目：

├── README.md
├── cloudbaserc.json
├── guides
│   └── README.md
└── package.json

项目部署

安装依赖

npm i

构建部署

npm run deploy

部署成功

执行 npm run deploy 稍等片刻之后即可部署成功，命令行会返回一个访问域名，笔者的为 https://cloudbase-test-9gccjnk3e393c02a-1256377994.tcloudbaseapp.com/vuepress/ ，点击即可访问示例网站，如下：

image.png

到这里为止，其实部署工作就算是结束了，无需自己配置 NGINX 等复杂繁琐的操作，这就是云服务的魅力，同时该服务按量计费，对于笔者来说费用可以说是非常低了。

但是，仅此还不够，我们要配置 GitHub Action 之后，才能算完全放手部署这件事，做到完全自动化，将日常工作精力专注于文档编写就可以了。

GitHub Action 配置

如果初始化了一个项目的话，会看到项目中有一个 cloudbaserc.json 文件，该文件为 cloudbase 配置文件，文件中有一个 envId 配置项，这属于敏感信息，请注意千万不要上传到 GitHub 中，将该配置信息从 cloudbaserc.json 中删除！

既然不能上传的话，我们应该如何配置呢，答案很简单，使用 GitHub secret 即可。需要在腾讯云控制台新建秘钥，新建完成后，打开你的 GitHub 仓库进行如下设置：

image.png

创建 ENVID、SECRETID、SECRETKEY 三条 secret，其中 ENVID 在应用列表中可见，配置完成后如下所示：

image.png

接下来在项目的 .github/workflows 目录下创建 deploy.yml 文件，内容如下：

name: 自动化部署

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

jobs:
  deploy:
    runs-on: ubuntu-latest
    name: deploy
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Deploy to Tencent CloudBase
        uses: TencentCloudBase/cloudbase-action@v2
        with:
          secretId: ${{ secrets.SECRETID }}
          secretKey: ${{ secrets.SECRETKEY }}
          envId: ${{ secrets.ENVID }}

然后将你的项目代码 push 到 GitHub 就可以完成自动化部署了，之后就可以专心进行文档编写，无需关心服务器维护这样的事情了。