代码拉取完成,页面将自动刷新
同步操作将从 aics/docs 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
基于
vitepress
搭建在线文档模板,支持 markdown 标题搜索,vue3
组件与js
代码运行
可快速搭建 vue 3.x 项目技术文档。
如果感觉对您有用,欢迎 star
git clone git@github.com:appbest/docs.git
# yarn 安装
yarn
# 调试
yarn docs:dev
# 打包
yarn docs:build
清除缓存目录,
/node_modules/.vite_opt_cache
/node_modules/.vite
keywords.json
,删除将生成最新数据源2022/4/1
qve
:0.3.9
2022/1/15
qve
:0.3.5
quick-plugin-md
:0.2.3
CodeRun
代码在线调试<CodeRun dll="json" styled="height:20rem" ubb editable>
// js 在线测试执行代码
return 'test';
</CodeRun>
发布到服务器时需要将源图标文件夹 /docs/fonts
内容复制到打包的 /dist/
目录
如需动态编译执行 vue
组件代码,需修改源码
vitepress
版本 0.21.4
需修改以下路径代码 node_modeules
>vitepress
>dist
>node
>serve-3fdbda2c.js
// 第12309行注释,替换为编译
//const vueRuntimePath = "vue/dist/vue.runtime.esm-bundler.js";
const vueRuntimePath = 'vue/dist/vue.esm-bundler.js';
vitepress
版本 0.13.0
alias
配置失效,。
需修改以下路径代码 node_modeules
>vitepress
>dist
>node
>serve-3fdbda2c.js
// 第12333行注释,替换为编译
{
find: /^vue$/,
// replacement: require.resolve("vue/dist/vue.runtime.esm-bundler.js")
replacement: require.resolve("vue/dist/vue.esm-bundler.js")
}
目录名与文件名,请使用小写
vitepress
0.8.1 及以下需要,当前项目无需更新。
需要发布为二级目录时,调试正常正式发布时会导致路径错误, 需要修改以下文件。
node_modeules\vitepress\dist\client\app\utils.js
第 20 行(把整个 base 路径删除了导致 Bug 修改为 1 正常取值)
//pagePath = pagePath.slice(base.length).replace(/\//g, '_') + '.md';
// 网站路径替换为文档目录
pagePath = 'docs/' + pagePath.slice(base.length);
pagePath = pagePath.replace(/\//g, '_') + '.md';
// console.log(base,pagePath);
# 初始化
git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin git@github.com:appbest/docs.git
git push -u origin main
#!/usr/bin/env sh
# 忽略错误
set -e
# 构建
# npm run docs:build
# 进入待发布的目录
cd docs/.vitepress/dist
# 如果是发布到自定义域名
# echo 'www.example.com' > CNAME
git init
git add -A
git commit -m 'deploy'
# 如果部署到 https://<USERNAME>.github.io
# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master
# 如果是部署到 pages https://<USERNAME>.github.io/<REPO>
git push -f git@github.com:appbest/docs.git master:gh-pages
# 同步部署到 qve.gitee.io/docs/
git push -f git@gitee.com:qve/docs.git master:gh-pages
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。