test/fes.js
1
0
Fork 0
mirror of https://gitee.com/WeBank/fes.js.git synced 2024-12-01 19:27:47 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

docs: fix docs deploy

Browse Source
This commit is contained in:
winixt 2023-04-24 15:59:04 +08:00
parent f4e4bde755
commit 4b2689c5eb
5 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/docs.yml vendored
View File

@ -27,7 +27,7 @@ jobs:
# 本地.ssh文件下的私钥id_rsa，存在secrets的TOKEN中 # 本地.ssh文件下的私钥id_rsa，存在secrets的TOKEN中
SSH_PRIVATE_KEY: ${{ secrets.HARRYWAN_PRIVATE_KEY }} SSH_PRIVATE_KEY: ${{ secrets.HARRYWAN_PRIVATE_KEY }}
# 源目录，相对于$GITHUB_WORKSPACE根目录的路径 # 源目录，相对于$GITHUB_WORKSPACE根目录的路径
SOURCE: docs/.vuepress/dist/ SOURCE: docs/.vitepress/dist/
# 服务器域名 # 服务器域名
REMOTE_HOST: ${{ secrets.TX_IP }} REMOTE_HOST: ${{ secrets.TX_IP }}
# 腾讯云默认用户名为root # 腾讯云默认用户名为root
@ -55,5 +55,5 @@ jobs:
uses: JamesIves/github-pages-deploy-action@v4.3.3 uses: JamesIves/github-pages-deploy-action@v4.3.3
with: with:
branch: gh-pages # The branch the action should deploy to. branch: gh-pages # The branch the action should deploy to.
folder: docs/.vuepress/dist folder: docs/.vitepress/dist
token: ${{ secrets.ACCESS_TOKEN }} token: ${{ secrets.ACCESS_TOKEN }}

2
.gitignore vendored
View File

@ -16,7 +16,7 @@ node_modules
npm-debug.log npm-debug.log
docs/.vitepress/cache docs/.vitepress/cache
/packages/fes-template/dist /packages/fes-template/dist
/packages/fes-doc/docs/.vuepress/dist /packages/fes-doc/docs/.vitepress/dist
/packages/fes-template/package-lock.json /packages/fes-template/package-lock.json
/.changelog /.changelog
/packages/*/lib /packages/*/lib

1
docs/.vitepress/configs/navbar/zh.ts
View File

@ -1,4 +1,3 @@
// import type { NavbarConfig } from '@vuepress/theme-default'
import { version } from '../../../../package.json' import { version } from '../../../../package.json'
export const zh = [ export const zh = [

1
docs/.vitepress/configs/sidebar/zh.ts
View File

@ -1,4 +1,3 @@
// import type { SidebarConfig } from '@vuepress/theme-default';
export const zh = { export const zh = {
'/guide/': [ '/guide/': [

6
docs/guide/contributing.md
View File

@ -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 文件 #### 第二步：修改 md 文件
菜单配置在`/docs/.vuepress/configs/sidebar/zh.ts`中，可以通过此配置找到对应想修改的文档。 菜单配置在`/docs/.vitpress/configs/sidebar/zh.ts`中，可以通过此配置找到对应想修改的文档。
如果想添加图片，则可以先把图片添加至`/docs/.vuepress/public`，在代码中使用： 如果想添加图片，则可以先把图片添加至`/docs/.vitpress/public`，在代码中使用：
```html ```html
<img :src="withBase('framework.png')" alt="架构" /> <img :src="withBase('framework.png')" alt="架构" />