The documentation is a work in progress, and English edition is just an empty shell for now. I will translate it when Chinese edition has done.
v-no 会使用语义化版本号进行版本更迭,但它暂时不会单独发布 Release。你可以克隆 / 下载随版本号更新的网站模板,以它为基础搭建你自己的网站。如果它不能满足你的部署需求,你需要下载对应版本的项目源码,自行编译 v-no。你当然也可以克隆项目仓库,编译它以获取最新的开发版本代码。
在你有了一份可以用于部署的代码后,需要准备几个用于初始化的文件(它们包含在网站模板中):
assets/config.js
:配置文件。- 六个
.md
文件:archives.md
categories.md
common.md
index.md
README.md
search.md
你在配置 v-no 中能找到更多内容。
v-no 可以部署到任意一个你喜欢的 Web 服务。除了各个服务对静态资源的基本配置,它几乎不需要你做更多额外的部署工作。
这里简单举几个例子:
部署到 GitHub Pages
如果你不是部署网站模板,可以从第四步开始。
- 选择一个模板仓库。
- 点击仓库主页的 Use this template 按钮,为自己克隆一份当前模板的拷贝。
- 填写你的仓库名。因为 GitHub Pages 会把除
username.github.io
(username 是你的用户名)以外的仓库都部署到它们的仓库目录。如果你没有准备自定义域名,或者不想在之后重新编译 v-no,它就只能是username.github.io
。 - 转到你自己的网站仓库的 Settings 页面。
- 滚动到 GitHub Pages 配置项。
- Source 选择 master(或许是 main)。
- (可选)填写 Custom domain。你可能需要参考 GitHub 官方文档来配置自定义域名。
部署到 Internet Information Services (IIS)
- 右键添加网站。
- 填写网站名称。
- 填写物理路径。如果你的
VUE_APP_PUBLIC_PATH
环境变量 是/
,它就是网站根目录的路径;如果不是,你需要指定它的上级目录的路径。 - 检查端口。
IIS 有些特殊,你可能还需要配置一下 .md
文件的 MIME 类型:
- 在你填写物理路径下新建一个
web.config
文件。 - 将下面的代码拷贝进去:
你还有可能遇到 IIS 无权读取文件的问题,记得要右键为网站目录添加 Everyone 读取权限。
部署在 Node.js
v-no-script 有个帮助你启动 Web 服务的脚本,它专门设计用来在本地部署 v-no。
它除了可以部署静态资源,也能为 v-no 植入一个 WebSocket 客户端,让它能响应网站目录下的 index.html
、assets/config.js
和 .md
文件的修改,自动重载 / 刷新页面(Hot / Live reload)。
它需要你在 .env
文件中正确填写下面的配置项才能正常工作:
SITE_PATH | 网站根目录的路径。不能为空。 |
PORT | 端口。可以为空,默认为 3000 。 |
PUBLIC_PATH | 和 VUE_APP_PUBLIC_PATH 环境变量一致。可以为空,默认为 / 。 |
INDEX_PATH | 和 VUE_APP_INDEX_PATH 环境变量一致。可以为空,默认为 -/index.html 。 |
COMMON_FILE | 和 config.paths.common 配置项 一致。可以为空,默认为 /common.md 。 |
EXCLUDE_DIRS | 不监听文件修改的目录名,用英文逗号进行分隔。它们会被追加进 ['.git', 'node_modules', 'assets'] 列表。 |
DISABLE_WS | 禁用 WebSocket 服务,通常用于预渲染。如果它不为空,则视为 true。 |
- This page is open source, improve it