mirror of
https://gitee.com/WeBank/fes.js.git
synced 2024-11-29 10:17:45 +08:00
docs: fix docs deploy
This commit is contained in:
parent
f4e4bde755
commit
4b2689c5eb
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@ -27,7 +27,7 @@ jobs:
|
||||
# 本地.ssh文件下的私钥id_rsa,存在secrets的TOKEN中
|
||||
SSH_PRIVATE_KEY: ${{ secrets.HARRYWAN_PRIVATE_KEY }}
|
||||
# 源目录,相对于$GITHUB_WORKSPACE根目录的路径
|
||||
SOURCE: docs/.vuepress/dist/
|
||||
SOURCE: docs/.vitepress/dist/
|
||||
# 服务器域名
|
||||
REMOTE_HOST: ${{ secrets.TX_IP }}
|
||||
# 腾讯云默认用户名为root
|
||||
@ -55,5 +55,5 @@ jobs:
|
||||
uses: JamesIves/github-pages-deploy-action@v4.3.3
|
||||
with:
|
||||
branch: gh-pages # The branch the action should deploy to.
|
||||
folder: docs/.vuepress/dist
|
||||
folder: docs/.vitepress/dist
|
||||
token: ${{ secrets.ACCESS_TOKEN }}
|
||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -16,7 +16,7 @@ node_modules
|
||||
npm-debug.log
|
||||
docs/.vitepress/cache
|
||||
/packages/fes-template/dist
|
||||
/packages/fes-doc/docs/.vuepress/dist
|
||||
/packages/fes-doc/docs/.vitepress/dist
|
||||
/packages/fes-template/package-lock.json
|
||||
/.changelog
|
||||
/packages/*/lib
|
||||
|
@ -1,4 +1,3 @@
|
||||
// import type { NavbarConfig } from '@vuepress/theme-default'
|
||||
import { version } from '../../../../package.json'
|
||||
|
||||
export const zh = [
|
||||
|
@ -1,4 +1,3 @@
|
||||
// import type { SidebarConfig } from '@vuepress/theme-default';
|
||||
|
||||
export const zh = {
|
||||
'/guide/': [
|
||||
|
@ -49,7 +49,7 @@ pnpm i
|
||||
|
||||
## 贡献文档
|
||||
|
||||
文档代码在`docs`目录,基于 [vuepress](https://v2.vuepress.vuejs.org/zh/) 实现。
|
||||
文档代码在`docs`目录,基于 [vitepress](https://vitepress.dev/guide/what-is-vitepress) 实现。
|
||||
|
||||
#### 第一步:启动服务
|
||||
|
||||
@ -59,9 +59,9 @@ pnpm docs:dev
|
||||
|
||||
#### 第二步:修改 md 文件
|
||||
|
||||
菜单配置在`/docs/.vuepress/configs/sidebar/zh.ts`中,可以通过此配置找到对应想修改的文档。
|
||||
菜单配置在`/docs/.vitpress/configs/sidebar/zh.ts`中,可以通过此配置找到对应想修改的文档。
|
||||
|
||||
如果想添加图片,则可以先把图片添加至`/docs/.vuepress/public`,在代码中使用:
|
||||
如果想添加图片,则可以先把图片添加至`/docs/.vitpress/public`,在代码中使用:
|
||||
|
||||
```html
|
||||
<img :src="withBase('framework.png')" alt="架构" />
|
||||
|
Loading…
Reference in New Issue
Block a user