@modern-js/main-doc 2.32.0 → 2.32.2-alpha.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/docs/en/apis/app/runtime/app/define-config.mdx +2 -2
  3. package/docs/en/apis/app/runtime/model/auto-actions.mdx +2 -2
  4. package/docs/en/apis/app/runtime/model/model_.mdx +0 -1
  5. package/docs/en/apis/app/runtime/model/use-static-model.mdx +1 -1
  6. package/docs/en/components/enable-bff-caution.mdx +1 -1
  7. package/docs/en/configure/app/auto-load-plugin.mdx +2 -2
  8. package/docs/en/configure/app/bff/_category_.json +1 -1
  9. package/docs/en/configure/app/builder-plugins.mdx +2 -2
  10. package/docs/en/configure/app/dev/_category_.json +1 -1
  11. package/docs/en/configure/app/experiments/_category_.json +1 -1
  12. package/docs/en/configure/app/html/_category_.json +1 -1
  13. package/docs/en/configure/app/output/_category_.json +1 -1
  14. package/docs/en/configure/app/output/ssg.mdx +1 -1
  15. package/docs/en/configure/app/plugins.mdx +0 -1
  16. package/docs/en/configure/app/runtime/_category_.json +1 -1
  17. package/docs/en/configure/app/security/_category_.json +1 -1
  18. package/docs/en/configure/app/server/_category_.json +1 -1
  19. package/docs/en/configure/app/source/_category_.json +1 -1
  20. package/docs/en/configure/app/source/enable-async-entry.mdx +1 -1
  21. package/docs/en/configure/app/source/mainEntryName.mdx +1 -1
  22. package/docs/en/configure/app/testing/_category_.json +1 -1
  23. package/docs/en/configure/app/tools/_category_.json +1 -1
  24. package/docs/en/configure/app/tools/tailwindcss.mdx +45 -5
  25. package/docs/en/guides/advanced-features/bff/_category_.json +1 -1
  26. package/docs/en/guides/advanced-features/bff/frameworks.mdx +2 -2
  27. package/docs/en/guides/advanced-features/bff/function.mdx +1 -1
  28. package/docs/en/guides/advanced-features/code-split.mdx +2 -2
  29. package/docs/en/guides/advanced-features/eslint.mdx +2 -2
  30. package/docs/en/guides/advanced-features/low-level.mdx +2 -2
  31. package/docs/en/guides/advanced-features/ssg.mdx +2 -3
  32. package/docs/en/guides/advanced-features/ssr.mdx +2 -3
  33. package/docs/en/guides/advanced-features/testing.mdx +3 -3
  34. package/docs/en/guides/advanced-features/using-storybook.mdx +1 -1
  35. package/docs/en/guides/advanced-features/web-server.mdx +2 -2
  36. package/docs/en/guides/basic-features/alias.mdx +3 -3
  37. package/docs/en/guides/basic-features/css.mdx +27 -64
  38. package/docs/en/guides/basic-features/data-fetch.mdx +2 -2
  39. package/docs/en/guides/basic-features/env-vars.mdx +2 -2
  40. package/docs/en/guides/basic-features/html.mdx +0 -1
  41. package/docs/en/guides/basic-features/mock.mdx +4 -4
  42. package/docs/en/guides/basic-features/proxy.mdx +3 -3
  43. package/docs/en/guides/basic-features/routes.mdx +1 -2
  44. package/docs/en/guides/concept/builder.mdx +2 -2
  45. package/docs/en/guides/concept/entries.mdx +1 -1
  46. package/docs/en/guides/get-started/upgrade.mdx +1 -2
  47. package/docs/en/guides/topic-detail/framework-plugin/hook.mdx +2 -2
  48. package/docs/en/guides/topic-detail/generator/plugin/category.md +1 -1
  49. package/docs/en/guides/topic-detail/generator/plugin/context.md +1 -1
  50. package/docs/en/guides/topic-detail/micro-frontend/c02-development.mdx +2 -2
  51. package/docs/en/guides/topic-detail/model/auto-actions.mdx +1 -1
  52. package/docs/en/guides/topic-detail/model/performance.mdx +2 -1
  53. package/docs/en/guides/topic-detail/model/typescript-best-practice.mdx +1 -1
  54. package/docs/en/guides/topic-detail/model/use-model.mdx +1 -1
  55. package/docs/en/tutorials/first-app/c05-loader.mdx +0 -2
  56. package/docs/zh/community/releases.mdx +1 -1
  57. package/docs/zh/community/team.mdx +1 -1
  58. package/docs/zh/components/enable-bff-caution.mdx +2 -2
  59. package/docs/zh/configure/app/auto-load-plugin.mdx +2 -3
  60. package/docs/zh/configure/app/bff/_category_.json +2 -2
  61. package/docs/zh/configure/app/builder-plugins.mdx +2 -3
  62. package/docs/zh/configure/app/deploy/_category_.json +1 -1
  63. package/docs/zh/configure/app/dev/_category_.json +2 -2
  64. package/docs/zh/configure/app/experiments/_category_.json +2 -2
  65. package/docs/zh/configure/app/html/_category_.json +2 -2
  66. package/docs/zh/configure/app/output/_category_.json +2 -2
  67. package/docs/zh/configure/app/output/ssg.mdx +1 -1
  68. package/docs/zh/configure/app/performance/_category_.json +1 -1
  69. package/docs/zh/configure/app/plugins.mdx +1 -2
  70. package/docs/zh/configure/app/runtime/_category_.json +2 -2
  71. package/docs/zh/configure/app/security/_category_.json +2 -2
  72. package/docs/zh/configure/app/server/_category_.json +2 -2
  73. package/docs/zh/configure/app/source/_category_.json +2 -2
  74. package/docs/zh/configure/app/testing/_category_.json +2 -2
  75. package/docs/zh/configure/app/tools/_category_.json +2 -2
  76. package/docs/zh/configure/app/tools/tailwindcss.mdx +44 -6
  77. package/docs/zh/guides/advanced-features/bff/_category_.json +1 -1
  78. package/docs/zh/guides/advanced-features/code-split.mdx +2 -2
  79. package/docs/zh/guides/advanced-features/compatibility.mdx +1 -1
  80. package/docs/zh/guides/advanced-features/eslint.mdx +1 -1
  81. package/docs/zh/guides/advanced-features/low-level.mdx +2 -2
  82. package/docs/zh/guides/advanced-features/rspack-start.mdx +0 -1
  83. package/docs/zh/guides/advanced-features/ssg.mdx +3 -4
  84. package/docs/zh/guides/advanced-features/ssr.mdx +2 -3
  85. package/docs/zh/guides/advanced-features/testing.mdx +2 -2
  86. package/docs/zh/guides/advanced-features/using-storybook.mdx +1 -1
  87. package/docs/zh/guides/advanced-features/web-server.mdx +2 -2
  88. package/docs/zh/guides/basic-features/alias.mdx +3 -3
  89. package/docs/zh/guides/basic-features/css.mdx +27 -64
  90. package/docs/zh/guides/basic-features/data-fetch.mdx +1 -2
  91. package/docs/zh/guides/basic-features/env-vars.mdx +1 -1
  92. package/docs/zh/guides/basic-features/mock.mdx +2 -2
  93. package/docs/zh/guides/basic-features/proxy.mdx +3 -3
  94. package/docs/zh/guides/basic-features/routes.mdx +1 -2
  95. package/docs/zh/guides/concept/builder.mdx +1 -1
  96. package/docs/zh/guides/concept/entries.mdx +3 -3
  97. package/docs/zh/guides/get-started/upgrade.mdx +1 -2
  98. package/modern.config.ts +8 -0
  99. package/package.json +5 -5
  100. package/src/i18n/enUS.ts +1 -1
  101. package/src/i18n/zhCN.ts +1 -1
  102. package/docs/en/configure/app/source/design-system.mdx +0 -1175
  103. package/docs/zh/configure/app/source/design-system.mdx +0 -1174
@@ -1,7 +1,7 @@
1
1
  ---
2
- title: 数据模拟
3
- sidebar_position: 6
2
+ sidebar_position: 5
4
3
  ---
4
+
5
5
  # 数据模拟
6
6
 
7
7
  Modern.js 提供了快速生成 Mock 数据的功能,能够让前端独立自主开发,不被后端接口阻塞。
@@ -1,8 +1,8 @@
1
1
  ---
2
- title: 代理
3
- sidebar_position: 5
2
+ sidebar_position: 6
4
3
  ---
5
- # 代理
4
+
5
+ # 网络代理
6
6
 
7
7
  ## 本地代理
8
8
 
@@ -1,9 +1,8 @@
1
1
  ---
2
- title: 路由
3
2
  sidebar_position: 1
4
3
  ---
5
4
 
6
- # 路由
5
+ # 路由方案
7
6
 
8
7
  Modern.js 的路由基于 [React Router 6](https://reactrouter.com/en/main),并提供了多种类型的路由模式。根据不同 [入口](/guides/concept/entries) 类型,将路由分为三种模式,分别是**约定式路由**,**自控式路由**和**其他路由方案**。
9
8
 
@@ -16,7 +16,7 @@ Modern.js Builder 是 Modern.js 体系的核心组件之一,它是一个面向
16
16
  - 通用构建引擎:Modern.js Builder。
17
17
  - 底层打包工具:webpack 和 Rspack。
18
18
 
19
- <img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/builder-layers-1117.png" style={{ width: '100%', maxWidth: '540px' }} />
19
+ <img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/builder-layers-0824.png" style={{ width: '100%', maxWidth: '540px' }} />
20
20
 
21
21
  ## 构建文档
22
22
 
@@ -2,7 +2,7 @@
2
2
  sidebar_position: 1
3
3
  ---
4
4
 
5
- # 入口
5
+ # 页面入口
6
6
 
7
7
  通过本章节,你可以了解到 Modern.js 中的入口约定,以及如何自定义入口。
8
8
 
@@ -114,7 +114,7 @@ import EntryMode from '@site-docs/components/entry-mode.mdx';
114
114
 
115
115
  上述目录中,`layout.tsx` 中导出的组件会作为最外层的组件,`page.tsx` 中导出的组件会作为 `/` 路由的组件。
116
116
 
117
- 详细内容可以参考[路由](/guides/basic-features/routes#约定式路由)。
117
+ 详细内容可以参考[路由方案](/guides/basic-features/routes#约定式路由)。
118
118
 
119
119
  #### 自控式路由
120
120
 
@@ -135,7 +135,7 @@ export default () => {
135
135
  };
136
136
  ```
137
137
 
138
- 详细内容可以参考[路由](/guides/basic-features/routes#自控式路由)。
138
+ 详细内容可以参考[路由方案](/guides/basic-features/routes#自控式路由)。
139
139
 
140
140
  #### 自定义 Bootstrap
141
141
 
@@ -1,9 +1,8 @@
1
1
  ---
2
- title: 升级
3
2
  sidebar_position: 3
4
3
  ---
5
4
 
6
- # 升级
5
+ # 版本升级
7
6
 
8
7
  ## 通过命令行升级
9
8
 
package/modern.config.ts CHANGED
@@ -133,6 +133,14 @@ export default defineConfig({
133
133
  // exclude document fragments from routes
134
134
  exclude: ['scripts/**', '**/zh/components/**', '**/en/components/**'],
135
135
  },
136
+ replaceRules: [
137
+ {
138
+ // The major version is different inside the ByteDance,
139
+ // so we use a flag to define it.
140
+ search: /MAJOR_VERSION/g,
141
+ replace: '2',
142
+ },
143
+ ],
136
144
  builderConfig: {
137
145
  output: {
138
146
  disableTsChecker: true,
package/package.json CHANGED
@@ -15,14 +15,14 @@
15
15
  "modern",
16
16
  "modern.js"
17
17
  ],
18
- "version": "2.32.0",
18
+ "version": "2.32.2-alpha.1",
19
19
  "publishConfig": {
20
20
  "registry": "https://registry.npmjs.org/",
21
21
  "access": "public",
22
22
  "provenance": true
23
23
  },
24
24
  "peerDependencies": {
25
- "@modern-js/builder-doc": "^2.32.0"
25
+ "@modern-js/builder-doc": "^2.32.2-alpha.1"
26
26
  },
27
27
  "devDependencies": {
28
28
  "classnames": "^2",
@@ -34,9 +34,9 @@
34
34
  "fs-extra": "^10",
35
35
  "@types/node": "^16",
36
36
  "@types/fs-extra": "^9",
37
- "@modern-js/builder-doc": "2.32.0",
38
- "@modern-js/doc-tools": "2.32.0",
39
- "@modern-js/doc-plugin-auto-sidebar": "2.32.0"
37
+ "@modern-js/builder-doc": "2.32.2-alpha.1",
38
+ "@modern-js/doc-tools": "2.32.2-alpha.1",
39
+ "@modern-js/doc-plugin-auto-sidebar": "2.32.2-alpha.1"
40
40
  },
41
41
  "scripts": {
42
42
  "dev": "modern dev",
package/src/i18n/enUS.ts CHANGED
@@ -18,7 +18,7 @@ export const EN_US = {
18
18
  feature4: 'Multi-Rendering Mode',
19
19
  featureDesc4: 'SSR, SSG, SPR, all out of the box for you.',
20
20
  feature5: 'CSS Solutions',
21
- featureDesc5: 'CSS Modules, CSS-in-JS, TailwindCSS, take your pick.',
21
+ featureDesc5: 'CSS Modules, CSS-in-JS, Tailwind CSS, take your pick.',
22
22
  feature6: 'Easy to Configure',
23
23
  featureDesc6:
24
24
  'Launch with zero configuration, then everything is configurable.',
package/src/i18n/zhCN.ts CHANGED
@@ -19,7 +19,7 @@ export const ZH_CN: Record<keyof typeof EN_US, string> = {
19
19
  feature4: '多渲染模式',
20
20
  featureDesc4: 'SSR、SSG、SPR 等多种渲染模式,通通开箱即用。',
21
21
  feature5: 'CSS 方案',
22
- featureDesc5: 'CSS Modules、CSS-in-JS、TailwindCSS,任你挑选。',
22
+ featureDesc5: 'CSS Modules、CSS-in-JS、Tailwind CSS,任你挑选。',
23
23
  feature6: '易于配置',
24
24
  featureDesc6: '以零配置启动,然后一切皆可配置。',
25
25