本项目由 vuepress-theme-vdoing-template 创建。
vuepress-theme-vdoing-template 是 vuepress-theme-vdoing 的一个模板仓库,可帮助新用户快速使用 vdoing 主题。
本文只是简易文档,详细文档见 https://vdoing-template.u2sb.com 本项目仍在测试阶段,如遇到问题,请及时反馈
- 默认包管理工具: yarn 1
- 默认包安装镜像:npmmirror **镜像站
在开始之前,您需要了解
使用 vuepress-theme-vdoing-template 作为模板创建仓库,详见 从模板创建仓库
如不需要 github 相关的服务,可直接 clone 此仓库。
将你自己创建的仓库 clone 到电脑上,并安装以下依赖:
- Node.js LTS (长期维护版)
开启 yarn 支持
corepack enable
修改配置文件
推荐使用 Visual Studio Code 编辑。
- 编辑
docs/.vuepress/config.ts
和docs/.vuepress/config/
目录下的其他配置文件,详细见文件内注释。 - 替换
docs/.vuepress/public/
下的资源。
如不方便 clone ,可使用 GitHub Codespaces 功能在线编辑,进入编辑器方法为,在你的仓库内,按键盘
.
直接进入 (或将 url 的.com
修改为.dev
),然后使用 GitHub 账号登录,即可使用在线编辑功能,保存后一定要记得在编辑器提交更改。
安装依赖
yarn install
本地测试
yarn dev
测试过程中如遇到问题,向其他人请教时务必带有完整的控制台输出信息。
本地构建
yarn build
模板内的 ci 脚本可部署到多个平台,请修改 .github/workflows/deploy.yml
,取消注释对应的平台,并注释掉不需要的平台。
目前支持的平台有:
- GitHub
- 又拍云
密钥配置相关见 详细文档
提交并推送到 GitHub,项目会自动编译。
- vuepress-plugin-fulltext-search
- vuepress-plugin-one-click-copy
- vuepress-plugin-pangu
- vuepress-plugin-sitemap
- vuepress-plugin-smplayer
- vuepress-plugin-zooming
- markdown-it-attrs
- markdown-it-footnote
- markdown-it-imsize
- markdown-it-mathjax3
- markdown-it-sub
- markdown-it-sup
- markdown-it-task-lists
如非必要,请勿删除本说明文件,保留本说明文件可以帮助更多的人。