diff --git a/docs/.vuepress/configs/navbar/zh.ts b/docs/.vuepress/configs/navbar/zh.ts index 91260e5e..9c60a244 100644 --- a/docs/.vuepress/configs/navbar/zh.ts +++ b/docs/.vuepress/configs/navbar/zh.ts @@ -6,76 +6,92 @@ export const zh: NavbarConfig = [ link: '/zh/guide/', }, { - text: '参考', - children: [ - { - text: 'VuePress', - children: [ - '/zh/reference/cli.md', - '/zh/reference/config.md', - '/zh/reference/frontmatter.md', - '/zh/reference/components.md', - '/zh/reference/plugin-api.md', - '/zh/reference/theme-api.md', - ], - }, - { - text: '打包工具', - children: [ - '/zh/reference/bundler/webpack.md', - '/zh/reference/bundler/vite.md', - ], - }, - { - text: '默认主题', - children: [ - '/zh/reference/default-theme/config.md', - '/zh/reference/default-theme/frontmatter.md', - '/zh/reference/default-theme/components.md', - '/zh/reference/default-theme/markdown.md', - ], - }, - { - text: '官方插件', - link: '/zh/reference/plugin/', - children: [], - }, - ], + text: '配置', + link: '/zh/reference/config', }, { - text: '了解更多', - children: [ - { - text: '深入', - children: [ - '/zh/guide/advanced/markdown.md', - '/zh/guide/advanced/theme.md', - '/zh/guide/advanced/plugin.md', - ], - }, - { - text: '其他资源', - children: [ - '/zh/contributing.md', - { - text: '更新日志', - link: - 'https://github.com/vuepress/vuepress-next/blob/main/CHANGELOG.md', - }, - { - text: 'Awesome VuePress', - link: 'https://github.com/vuepress/awesome-vuepress', - }, - { - text: 'v1 文档', - link: 'https://v1.vuepress.vuejs.org/zh/', - }, - { - text: 'v0 文档', - link: 'https://v0.vuepress.vuejs.org/zh/', - }, - ], - }, - ], + text: 'API', + link: '/zh/reference/api', }, + { + text: '插件', + link: '/zh/reference/plugin', + }, + { + text: 'CLI', + link: '/zh/reference/cli', + }, + // { + // text: '参考', + // children: [ + // { + // text: 'VuePress', + // children: [ + // '/zh/reference/cli.md', + // '/zh/reference/config.md', + // '/zh/reference/frontmatter.md', + // '/zh/reference/components.md', + // '/zh/reference/plugin-api.md', + // '/zh/reference/theme-api.md', + // ], + // }, + // { + // text: '打包工具', + // children: [ + // '/zh/reference/bundler/webpack.md', + // '/zh/reference/bundler/vite.md', + // ], + // }, + // { + // text: '默认主题', + // children: [ + // '/zh/reference/default-theme/config.md', + // '/zh/reference/default-theme/frontmatter.md', + // '/zh/reference/default-theme/components.md', + // '/zh/reference/default-theme/markdown.md', + // ], + // }, + // { + // text: '官方插件', + // link: '/zh/reference/plugin/', + // children: [], + // }, + // ], + // }, + // { + // text: '了解更多', + // children: [ + // { + // text: '深入', + // children: [ + // '/zh/guide/advanced/markdown.md', + // '/zh/guide/advanced/theme.md', + // '/zh/guide/advanced/plugin.md', + // ], + // }, + // { + // text: '其他资源', + // children: [ + // '/zh/contributing.md', + // { + // text: '更新日志', + // link: + // 'https://github.com/vuepress/vuepress-next/blob/main/CHANGELOG.md', + // }, + // { + // text: 'Awesome VuePress', + // link: 'https://github.com/vuepress/awesome-vuepress', + // }, + // { + // text: 'v1 文档', + // link: 'https://v1.vuepress.vuejs.org/zh/', + // }, + // { + // text: 'v0 文档', + // link: 'https://v0.vuepress.vuejs.org/zh/', + // }, + // ], + // }, + // ], + // }, ] diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl new file mode 100644 index 00000000..a57e676b --- /dev/null +++ b/docs/.vuepress/styles/index.styl @@ -0,0 +1,3 @@ +.page + .page-meta, .page-nav, .theme-default-content:not(.custom) + max-width: 800px \ No newline at end of file diff --git a/docs/zh/README.md b/docs/zh/README.md index 8468afc0..f453014f 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -13,7 +13,7 @@ features: - title: Fast details: Fes内置了路由、开发、构建等，并且提供测试、布局、权限、国际化、状态管理、API请求、数据字典、SvgIcon等插件，可以满足大部分日常开发需求。 - title: Easy - details: 基于Vue.js 3.0，上手简单。贯彻“约定大于配置”思想，设计插件上尽可能用约定替代配置，同时提供统一的插件配置入口，简单简洁又不失灵活。提供一致性的API入口，一致化的体验，学习起来更轻松。 + details: 基于Vue.js 3.0，上手简单。贯彻“约定优于配置”思想，设计插件上尽可能用约定替代配置，同时提供统一的插件配置入口，简单简洁又不失灵活。提供一致性的API入口，一致化的体验，学习起来更轻松。 - title: Strong details: 只需要关心页面内容，减少犯错的机会！提供单元测试、覆盖测试的能力保障项目质量。 - title: 可扩展 @@ -23,7 +23,7 @@ features: footer: MIT Licensed | Copyright © 2020-present Webank --- -### 像数 1, 2, 3 一样容易 +## 像数 1, 2, 3 一样容易 @@ -57,7 +57,7 @@ npm run dev -### 反馈 +## 反馈 | Github Issue | 微信群 | Fes.js开源运营小助手 | | --- | --- | --- | diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md index cd3b38ac..d406a0f3 100644 --- a/docs/zh/guide/README.md +++ b/docs/zh/guide/README.md @@ -1,9 +1,24 @@ + # 介绍 + + +## 痛点 + +Fes.js 是一个好用的可扩展的前端应用解决方案。Fes 以 Vue 3.0 和 vue-router 路由为基础的，同时支持配置式路由和约定式路由，保证路由的功能完备，并以此进行功能扩展。然后配以生命周期完善的插件体系，覆盖从源码到构建产物的每个生命周期，支持各种功能扩展和业务需求。 + +Umi 是蚂蚁金服的底层前端框架，已直接或间接地服务了 3000+ 应用，包括 java、node、H5 无线、离线（Hybrid）应用、纯前端 assets 应用、CMS 应用等。他已经很好地服务了我们的内部用户，同时希望他也能服务好外部用户。 + VuePress 是一个以 Markdown 为中心的静态网站生成器。你可以使用 [Markdown](https://zh.wikipedia.org/wiki/Markdown) 来书写内容（如文档、博客等），然后 VuePress 会帮助你生成一个静态网站来展示它们。 VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求，但是现在它已经在帮助大量用户构建他们的文档、博客和其他静态网站。 +## Fes.js 是什么？ + +- :rocket: __Fast__ +- :fireworks: __Easy__ +- 💪 __Strong__ + ## 它是如何工作的？ 一个 VuePress 站点本质上是一个由 [Vue](https://v3.vuejs.org/) 和 [Vue Router](https://next.router.vuejs.org) 驱动的单页面应用 (SPA)。