diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 2b4776ba..74670d21 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -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 }} diff --git a/.gitignore b/.gitignore index 0b8aff0e..dc770bff 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/docs/.vitepress/configs/navbar/zh.ts b/docs/.vitepress/configs/navbar/zh.ts index 5ec0e523..8f24789c 100644 --- a/docs/.vitepress/configs/navbar/zh.ts +++ b/docs/.vitepress/configs/navbar/zh.ts @@ -1,4 +1,3 @@ -// import type { NavbarConfig } from '@vuepress/theme-default' import { version } from '../../../../package.json' export const zh = [ @@ -22,7 +21,7 @@ export const zh = [ }, { text: 'CLI', - link: '/reference/cli/', + link: '/reference/cli/index.md', }, { text: `v${version}`, diff --git a/docs/.vitepress/configs/sidebar/zh.ts b/docs/.vitepress/configs/sidebar/zh.ts index 7fb94c10..764978c8 100644 --- a/docs/.vitepress/configs/sidebar/zh.ts +++ b/docs/.vitepress/configs/sidebar/zh.ts @@ -1,4 +1,3 @@ -// import type { SidebarConfig } from '@vuepress/theme-default'; export const zh = { '/guide/': [ diff --git a/docs/guide/builder.md b/docs/guide/builder.md index 9ca4ffae..61042fb3 100644 --- a/docs/guide/builder.md +++ b/docs/guide/builder.md @@ -11,7 +11,7 @@ ### 配置 -Webpack 和 Vite 构建在配置方面有一些差异，具体可以查看[配置](../reference/config)。 +Webpack 和 Vite 构建在配置方面有一些差异，具体可以查看[配置](../reference/config/index.md)。 ### 静态文件处理 diff --git a/docs/guide/config.md b/docs/guide/config.md index 0732043e..5d64a94b 100644 --- a/docs/guide/config.md +++ b/docs/guide/config.md @@ -2,7 +2,7 @@ Fes.js 约定 `.fes.js` 文件为项目编译需要编译时配置文件，可以引入 `node` 端依赖项，不要引入浏览器端依赖项。 -一份常见的配置示例如下（更多配置项请查阅[配置](../reference/config))： +一份常见的配置示例如下（更多配置项请查阅[配置](../reference/config/index.md))： ```js import { defineBuildConfig } from '@fesjs/fes'; diff --git a/docs/guide/contributing.md b/docs/guide/contributing.md index 7f53a5cf..74c1bb14 100644 --- a/docs/guide/contributing.md +++ b/docs/guide/contributing.md @@ -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 架构 diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index f0ec6112..897e9915 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -126,7 +126,7 @@ Starting the development server http://localhost:8000 ... ::: -Fes.js 会在 [http://localhost:8000](http://localhost:8000) 启动一个热重载的开发服务器。当你修改你的 .vue 文件时，浏览器中的内容也会自动更新。 +Fes.js 会在 `http://localhost:8000` 启动一个热重载的开发服务器。当你修改你的 .vue 文件时，浏览器中的内容也会自动更新。 home diff --git a/docs/guide/upgrade3.md b/docs/guide/upgrade3.md index 32d09a78..2f0c6475 100644 --- a/docs/guide/upgrade3.md +++ b/docs/guide/upgrade3.md @@ -2,7 +2,7 @@ ## 版本 3.0.x 的 break -1. 编译时的 [base](../reference/config/#base) 配置，移到了 [router.base](../reference/config/#router) 下。 +1. 编译时的 [base](../reference/config/index.md/#base) 配置，移到了 [router.base](../reference/config/index.md/#router) 下。 2. [webpack-dev-server](https://github.com/webpack/webpack-dev-server) 从 `v3.x` 升级到了 `v4.x`，如果遇到配置不兼容，可以查看[webpack-dev-server 3.x 升级 4.x](https://github.com/webpack/webpack-dev-server/blob/master/migration-v4.md)。 ## 继续使用 Webpack @@ -13,7 +13,7 @@ ## 换成 Vite 1. 安装依赖包 `npm i @fesjs/builder-vite`。 -2. 将 Webpack 相关的配置换成 Vite，具体可查看[配置](../reference/config)。 +2. 将 Webpack 相关的配置换成 Vite，具体可查看[配置](../reference/config/index.md)。 3. 将 html 模版文件从 `public/index.html` 挪到项目根目录，如果有相应的 [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin) 配置，需要改成 [vite-plugin-html](https://github.com/vbenjs/vite-plugin-html) 的写法。 4. 将 `require` 等 Vite 不支持的代码，改写成 Vite 支持的方式。 @@ -21,6 +21,6 @@ 插件都需要升级到 `3.0.x` 版本，新版添加了兼容`builder`的逻辑，但是提供的接口和配置没有变化，只需要升级版本即可使用。 -- [@fesjs/plugin-layout](../reference/plugins/layout) 需要升级到`5.0.x`版本。 -- [@fesjs/plugin-locale](../reference/plugins/locale) 需要升级到`4.0.x`版本。 -- [@fesjs/plugin-qiankun](../reference/plugins/qiankun) 由于`qiankun`技术限制，子应用目前还只能使用 Webpack 构建。 \ No newline at end of file +- [@fesjs/plugin-layout](../reference/plugin/plugins/layout.md) 需要升级到`5.0.x`版本。 +- [@fesjs/plugin-locale](../reference/plugin/plugins/locale.md) 需要升级到`4.0.x`版本。 +- [@fesjs/plugin-qiankun](../reference/plugin/plugins/qiankun.md) 由于`qiankun`技术限制，子应用目前还只能使用 Webpack 构建。 diff --git a/docs/reference/cli.md b/docs/reference/cli.md deleted file mode 100644 index 364570fe..00000000 --- a/docs/reference/cli.md +++ /dev/null @@ -1,81 +0,0 @@ -# 命令行接口 - -VuePress 命令行接口是由 [@vuepress/cli](https://www.npmjs.com/package/@vuepress/cli) 包提供的。它是 [vuepress](https://www.npmjs.com/package/vuepress) 包的依赖之一，当然你也可以单独安装它。 - -执行 `vuepress --help` 来获取下列帮助信息： - -```bash -Usage: - $ vuepress [options] - -Commands: - dev [sourceDir] Start development server - build [sourceDir] Build to static site - info Display environment information - -For more info, run any command with the `--help` flag: - $ vuepress dev --help - $ vuepress build --help - $ vuepress info --help - -Options: - -v, --version Display version number - -h, --help Display this message -``` - -## dev - -启动一个开发服务器，在本地开发你的 VuePress 站点。 - -```bash -Usage: - $ vuepress dev [sourceDir] - -Options: - -c, --config Set path to config file - -p, --port Use specified port (default: 8000) - -t, --temp Set the directory of the temporary files - --host Use specified host (default: 0.0.0.0) - --cache Set the directory of the cache files - --clean-temp Clean the temporary files before dev - --clean-cache Clean the cache files before dev - --open Open browser when ready - --debug Enable debug mode - --no-watch Disable watching page and config files (default: true) - -v, --version Display version number - -h, --help Display this message -``` - -::: tip -通过命令行设置的配置项，会覆盖你配置文件中的同名配置项。 -::: - -## build - -将你的 VuePress 站点构建成静态文件，以便你进行后续[部署](../guide/deployment.md)。 - -```bash -Usage: - $ vuepress build [sourceDir] - -Options: - -c, --config Set path to config file - -d, --dest Set the directory build output (default: .vuepress/dist) - -t, --temp Set the directory of the temporary files - --cache Set the directory of the cache files - --clean-temp Clean the temporary files before build - --clean-cache Clean the cache files before build - --debug Enable debug mode - -v, --version Display version number - -h, --help Display this message -``` - -::: tip -通过命令行设置的配置项，会覆盖你配置文件中的同名配置项。 -::: - -## info - -输出当前系统和依赖相关的信息。 - -在你想要检查你的环境，或者提交 Issue 时候，可以使用该命令。 diff --git a/docs/reference/plugin/plugins/access.md b/docs/reference/plugin/plugins/access.md index cca4247a..ff6ac204 100644 --- a/docs/reference/plugin/plugins/access.md +++ b/docs/reference/plugin/plugins/access.md @@ -254,7 +254,7 @@ access.getAccess(); ### useAccess -- **类型**：[composition](<(https://v3.cn.vuejs.org/guide/composition-api-introduction.html)>) 函数 +- **类型**：[composition](https://vuejs.org/guide/extras/composition-api-faq.html#what-is-composition-api) 函数 - **详情**：判断某个资源是否可见。 - **参数**： - accessId，资源 Id