@modern-js/main-doc 0.0.0-next-1678386596804 → 0.0.0-next-1678457323655

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (194) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/CHANGELOG.md +13 -7
  3. package/en/configure/app/dev/asset-prefix.mdx +1 -1
  4. package/en/configure/app/dev/before-start-url.mdx +1 -1
  5. package/en/configure/app/dev/hmr.mdx +1 -1
  6. package/en/configure/app/dev/host.mdx +1 -1
  7. package/en/configure/app/dev/https.mdx +1 -1
  8. package/en/configure/app/dev/port.mdx +1 -1
  9. package/en/configure/app/dev/progress-bar.mdx +1 -1
  10. package/en/configure/app/dev/start-url.mdx +1 -1
  11. package/en/configure/app/experiments/lazy-compilation.mdx +1 -1
  12. package/en/configure/app/html/app-icon.mdx +1 -1
  13. package/en/configure/app/html/crossorigin.mdx +1 -1
  14. package/en/configure/app/html/disable-html-folder.mdx +1 -1
  15. package/en/configure/app/html/favicon-by-entries.mdx +1 -1
  16. package/en/configure/app/html/favicon.mdx +1 -1
  17. package/en/configure/app/html/inject-by-entries.mdx +1 -1
  18. package/en/configure/app/html/inject.mdx +1 -1
  19. package/en/configure/app/html/meta-by-entries.mdx +1 -1
  20. package/en/configure/app/html/meta.mdx +1 -1
  21. package/en/configure/app/html/mount-id.mdx +1 -1
  22. package/en/configure/app/html/tags-by-entries.mdx +1 -1
  23. package/en/configure/app/html/tags.mdx +1 -1
  24. package/en/configure/app/html/template-by-entries.mdx +1 -1
  25. package/en/configure/app/html/template-parameters-by-entries.mdx +1 -1
  26. package/en/configure/app/html/template-parameters.mdx +1 -1
  27. package/en/configure/app/html/template.mdx +1 -1
  28. package/en/configure/app/html/title-by-entries.mdx +1 -1
  29. package/en/configure/app/html/title.mdx +1 -1
  30. package/en/configure/app/output/asset-prefix.mdx +1 -1
  31. package/en/configure/app/output/assets-retry.mdx +1 -1
  32. package/en/configure/app/output/charset.mdx +1 -1
  33. package/en/configure/app/output/clean-dist-path.mdx +1 -1
  34. package/en/configure/app/output/convert-to-rem.mdx +1 -1
  35. package/en/configure/app/output/copy.mdx +1 -1
  36. package/en/configure/app/output/css-module-local-ident-name.mdx +1 -1
  37. package/en/configure/app/output/data-uri-limit.mdx +1 -1
  38. package/en/configure/app/output/disable-css-extract.mdx +1 -1
  39. package/en/configure/app/output/disable-css-module-extension.mdx +1 -1
  40. package/en/configure/app/output/disable-filename-hash.mdx +1 -1
  41. package/en/configure/app/output/disable-inline-runtime-chunk.mdx +1 -1
  42. package/en/configure/app/output/disable-minimize.mdx +1 -1
  43. package/en/configure/app/output/disable-source-map.mdx +1 -1
  44. package/en/configure/app/output/disable-ts-checker.mdx +1 -1
  45. package/en/configure/app/output/dist-path.mdx +1 -1
  46. package/en/configure/app/output/enable-asset-fallback.mdx +1 -1
  47. package/en/configure/app/output/enable-asset-manifest.mdx +1 -1
  48. package/en/configure/app/output/enable-css-module-tsdeclaration.mdx +1 -1
  49. package/en/configure/app/output/enable-inline-scripts.mdx +1 -1
  50. package/en/configure/app/output/enable-inline-styles.mdx +1 -1
  51. package/en/configure/app/output/enable-latest-decorators.mdx +1 -1
  52. package/en/configure/app/output/externals.mdx +1 -1
  53. package/en/configure/app/output/filename.mdx +1 -1
  54. package/en/configure/app/output/legal-comments.mdx +1 -1
  55. package/en/configure/app/output/override-browserslist.mdx +1 -1
  56. package/en/configure/app/output/polyfill.mdx +1 -1
  57. package/en/configure/app/output/svg-default-export.mdx +1 -1
  58. package/en/configure/app/performance/build-cache.mdx +1 -1
  59. package/en/configure/app/performance/bundle-analyze.mdx +1 -1
  60. package/en/configure/app/performance/chunk-split.mdx +1 -1
  61. package/en/configure/app/performance/print-file-size.mdx +1 -1
  62. package/en/configure/app/performance/profile.mdx +1 -1
  63. package/en/configure/app/performance/remove-console.mdx +1 -1
  64. package/en/configure/app/performance/remove-moment-locale.mdx +1 -1
  65. package/en/configure/app/security/check-syntax.mdx +1 -1
  66. package/en/configure/app/security/sri.mdx +1 -1
  67. package/en/configure/app/source/alias.mdx +1 -1
  68. package/en/configure/app/source/compile-js-data-uri.mdx +1 -1
  69. package/en/configure/app/source/define.mdx +1 -1
  70. package/en/configure/app/source/exclude.mdx +1 -1
  71. package/en/configure/app/source/global-vars.mdx +1 -1
  72. package/en/configure/app/source/include.mdx +1 -1
  73. package/en/configure/app/source/module-scopes.mdx +1 -1
  74. package/en/configure/app/source/pre-entry.mdx +1 -1
  75. package/en/configure/app/source/resolve-extension-prefix.mdx +1 -1
  76. package/en/configure/app/source/resolve-main-fields.mdx +1 -1
  77. package/en/configure/app/tools/autoprefixer.mdx +1 -1
  78. package/en/configure/app/tools/babel.mdx +1 -1
  79. package/en/configure/app/tools/css-extract.mdx +1 -1
  80. package/en/configure/app/tools/css-loader.mdx +1 -1
  81. package/en/configure/app/tools/dev-server.mdx +1 -1
  82. package/en/configure/app/tools/html-plugin.mdx +1 -1
  83. package/en/configure/app/tools/inspector.mdx +1 -1
  84. package/en/configure/app/tools/less.mdx +1 -1
  85. package/en/configure/app/tools/minify-css.mdx +1 -1
  86. package/en/configure/app/tools/postcss.mdx +1 -1
  87. package/en/configure/app/tools/pug.mdx +1 -1
  88. package/en/configure/app/tools/rspack.mdx +1 -1
  89. package/en/configure/app/tools/sass.mdx +1 -1
  90. package/en/configure/app/tools/style-loader.mdx +1 -1
  91. package/en/configure/app/tools/styled-components.mdx +1 -1
  92. package/en/configure/app/tools/terser.mdx +1 -1
  93. package/en/configure/app/tools/ts-checker.mdx +1 -1
  94. package/en/configure/app/tools/ts-loader.mdx +1 -1
  95. package/en/configure/app/tools/webpack-chain.mdx +1 -1
  96. package/en/configure/app/tools/webpack.mdx +1 -1
  97. package/en/guides/get-started/introduction.mdx +30 -14
  98. package/package.json +3 -3
  99. package/scripts/config.ts +1 -1
  100. package/zh/configure/app/dev/asset-prefix.mdx +1 -1
  101. package/zh/configure/app/dev/before-start-url.mdx +1 -1
  102. package/zh/configure/app/dev/hmr.mdx +1 -1
  103. package/zh/configure/app/dev/host.mdx +1 -1
  104. package/zh/configure/app/dev/https.mdx +1 -1
  105. package/zh/configure/app/dev/port.mdx +1 -1
  106. package/zh/configure/app/dev/progress-bar.mdx +1 -1
  107. package/zh/configure/app/dev/start-url.mdx +1 -1
  108. package/zh/configure/app/experiments/lazy-compilation.mdx +1 -1
  109. package/zh/configure/app/html/app-icon.mdx +1 -1
  110. package/zh/configure/app/html/crossorigin.mdx +1 -1
  111. package/zh/configure/app/html/disable-html-folder.mdx +1 -1
  112. package/zh/configure/app/html/favicon-by-entries.mdx +1 -1
  113. package/zh/configure/app/html/favicon.mdx +1 -1
  114. package/zh/configure/app/html/inject-by-entries.mdx +1 -1
  115. package/zh/configure/app/html/inject.mdx +1 -1
  116. package/zh/configure/app/html/meta-by-entries.mdx +1 -1
  117. package/zh/configure/app/html/meta.mdx +1 -1
  118. package/zh/configure/app/html/mount-id.mdx +1 -1
  119. package/zh/configure/app/html/tags-by-entries.mdx +1 -1
  120. package/zh/configure/app/html/tags.mdx +1 -1
  121. package/zh/configure/app/html/template-by-entries.mdx +1 -1
  122. package/zh/configure/app/html/template-parameters-by-entries.mdx +1 -1
  123. package/zh/configure/app/html/template-parameters.mdx +1 -1
  124. package/zh/configure/app/html/template.mdx +1 -1
  125. package/zh/configure/app/html/title-by-entries.mdx +1 -1
  126. package/zh/configure/app/html/title.mdx +1 -1
  127. package/zh/configure/app/output/asset-prefix.mdx +1 -1
  128. package/zh/configure/app/output/assets-retry.mdx +1 -1
  129. package/zh/configure/app/output/charset.mdx +1 -1
  130. package/zh/configure/app/output/clean-dist-path.mdx +1 -1
  131. package/zh/configure/app/output/convert-to-rem.mdx +1 -1
  132. package/zh/configure/app/output/copy.mdx +1 -1
  133. package/zh/configure/app/output/css-module-local-ident-name.mdx +1 -1
  134. package/zh/configure/app/output/data-uri-limit.mdx +1 -1
  135. package/zh/configure/app/output/disable-css-extract.mdx +1 -1
  136. package/zh/configure/app/output/disable-css-module-extension.mdx +1 -1
  137. package/zh/configure/app/output/disable-filename-hash.mdx +1 -1
  138. package/zh/configure/app/output/disable-inline-runtime-chunk.mdx +1 -1
  139. package/zh/configure/app/output/disable-minimize.mdx +1 -1
  140. package/zh/configure/app/output/disable-source-map.mdx +1 -1
  141. package/zh/configure/app/output/disable-ts-checker.mdx +1 -1
  142. package/zh/configure/app/output/dist-path.mdx +1 -1
  143. package/zh/configure/app/output/enable-asset-fallback.mdx +1 -1
  144. package/zh/configure/app/output/enable-asset-manifest.mdx +1 -1
  145. package/zh/configure/app/output/enable-css-module-tsdeclaration.mdx +1 -1
  146. package/zh/configure/app/output/enable-inline-scripts.mdx +1 -1
  147. package/zh/configure/app/output/enable-inline-styles.mdx +1 -1
  148. package/zh/configure/app/output/enable-latest-decorators.mdx +1 -1
  149. package/zh/configure/app/output/externals.mdx +1 -1
  150. package/zh/configure/app/output/filename.mdx +1 -1
  151. package/zh/configure/app/output/legal-comments.mdx +1 -1
  152. package/zh/configure/app/output/override-browserslist.mdx +1 -1
  153. package/zh/configure/app/output/polyfill.mdx +1 -1
  154. package/zh/configure/app/output/svg-default-export.mdx +1 -1
  155. package/zh/configure/app/performance/build-cache.mdx +1 -1
  156. package/zh/configure/app/performance/bundle-analyze.mdx +1 -1
  157. package/zh/configure/app/performance/chunk-split.mdx +1 -1
  158. package/zh/configure/app/performance/print-file-size.mdx +1 -1
  159. package/zh/configure/app/performance/profile.mdx +1 -1
  160. package/zh/configure/app/performance/remove-console.mdx +1 -1
  161. package/zh/configure/app/performance/remove-moment-locale.mdx +1 -1
  162. package/zh/configure/app/security/check-syntax.mdx +1 -1
  163. package/zh/configure/app/security/sri.mdx +1 -1
  164. package/zh/configure/app/source/alias.mdx +1 -1
  165. package/zh/configure/app/source/compile-js-data-uri.mdx +1 -1
  166. package/zh/configure/app/source/define.mdx +1 -1
  167. package/zh/configure/app/source/exclude.mdx +1 -1
  168. package/zh/configure/app/source/global-vars.mdx +1 -1
  169. package/zh/configure/app/source/include.mdx +1 -1
  170. package/zh/configure/app/source/module-scopes.mdx +1 -1
  171. package/zh/configure/app/source/pre-entry.mdx +1 -1
  172. package/zh/configure/app/source/resolve-extension-prefix.mdx +1 -1
  173. package/zh/configure/app/source/resolve-main-fields.mdx +1 -1
  174. package/zh/configure/app/tools/autoprefixer.mdx +1 -1
  175. package/zh/configure/app/tools/babel.mdx +1 -1
  176. package/zh/configure/app/tools/css-extract.mdx +1 -1
  177. package/zh/configure/app/tools/css-loader.mdx +1 -1
  178. package/zh/configure/app/tools/dev-server.mdx +1 -1
  179. package/zh/configure/app/tools/html-plugin.mdx +1 -1
  180. package/zh/configure/app/tools/inspector.mdx +1 -1
  181. package/zh/configure/app/tools/less.mdx +1 -1
  182. package/zh/configure/app/tools/minify-css.mdx +1 -1
  183. package/zh/configure/app/tools/postcss.mdx +1 -1
  184. package/zh/configure/app/tools/pug.mdx +1 -1
  185. package/zh/configure/app/tools/rspack.mdx +1 -1
  186. package/zh/configure/app/tools/sass.mdx +1 -1
  187. package/zh/configure/app/tools/style-loader.mdx +1 -1
  188. package/zh/configure/app/tools/styled-components.mdx +1 -1
  189. package/zh/configure/app/tools/terser.mdx +1 -1
  190. package/zh/configure/app/tools/ts-checker.mdx +1 -1
  191. package/zh/configure/app/tools/ts-loader.mdx +1 -1
  192. package/zh/configure/app/tools/webpack-chain.mdx +1 -1
  193. package/zh/configure/app/tools/webpack.mdx +1 -1
  194. package/zh/guides/get-started/introduction.mdx +23 -7
@@ -8,6 +8,6 @@ sidebar_label: postcss
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.postcss](https://modernjs.dev/builder/api/config-tools.html#toolspostcss)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/postcss.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/postcss.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: pug
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.pug](https://modernjs.dev/builder/api/config-tools.html#toolspug)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/pug.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/pug.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: rspack
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.rspack](https://modernjs.dev/builder/api/config-tools.html#toolsrspack)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/rspack.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/rspack.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: sass
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.sass](https://modernjs.dev/builder/api/config-tools.html#toolssass)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/sass.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/sass.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: styleLoader
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.styleLoader](https://modernjs.dev/builder/api/config-tools.html#toolsstyleloader)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/styleLoader.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/styleLoader.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: styledComponents
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.styledComponents](https://modernjs.dev/builder/api/config-tools.html#toolsstyledcomponents)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/styledComponents.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/styledComponents.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: terser
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.terser](https://modernjs.dev/builder/api/config-tools.html#toolsterser)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/terser.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/terser.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: tsChecker
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.tsChecker](https://modernjs.dev/builder/api/config-tools.html#toolstschecker)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsChecker.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsChecker.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: tsLoader
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.tsLoader](https://modernjs.dev/builder/api/config-tools.html#toolstsloader)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsLoader.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/tsLoader.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: webpackChain
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.webpackChain](https://modernjs.dev/builder/api/config-tools.html#toolswebpackchain)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpackChain.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpackChain.md';
12
12
 
13
13
  <Main />
@@ -8,6 +8,6 @@ sidebar_label: webpack
8
8
  该配置由 Modern.js Builder 提供,更多信息可参考 [tools.webpack](https://modernjs.dev/builder/api/config-tools.html#toolswebpack)。
9
9
  :::
10
10
 
11
- import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpack.md'
11
+ import Main from '@modern-js/builder-doc/docs/zh/config/tools/webpack.md';
12
12
 
13
13
  <Main />
@@ -5,27 +5,43 @@ sidebar_position: 1
5
5
 
6
6
  # Modern.js 介绍
7
7
 
8
- **Modern.js** 是基于 React 的渐进式现代 Web 开发框架。
8
+ **Modern.js 是字节跳动 Web 工程体系的开源版本**,它提供多个解决方案,来帮助开发者解决不同研发场景下的问题。
9
9
 
10
- 框架内置多种开箱即用的开发工具,拥有极致的构建性能,支持零配置的渲染范式切换,一体化的 API 调用。并从三种工程方案出发(应用工程方案、模块工程方案,Monorepo 工程方案),支持全链路的前端研发。
10
+ 目前 Modern.js 包含三个解决方案,分别面向 Web 应用开发场景、npm 包开发场景和文档站开发场景:
11
11
 
12
- Modern.js 是字节跳动的底层前端研发框架,已经直接或间接的服务上千个应用,包括中后台、PC Web、H5 等多种应用场景。框架覆盖完整的生命周期,拥有完善的插件体系,提供高度定制能力。支持通过生成器插件自定义业务线专属的工程方案,定制各种功能扩展和业务需求,帮助开发者更快速的搭建应用。
12
+ ![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/Solutions-0602.png)
13
13
 
14
- ## 为什么使用 Modern.js
14
+ 作为 Modern.js 工程体系的一部分,以上每个解决方案都可以被单独使用,并且各自部署了独立的文档站点。开发者可以按需选择其中的一个或多个解决方案来使用。
15
+
16
+ ## 关于文档
17
+
18
+ **当前文档站对应的是 Modern.js 框架**,适用于开发 Web 应用。
19
+
20
+ - 如果你需要开发一个 npm 包,请移步至 [Modern.js Module](https://modernjs.dev/module-tools) 文档。
21
+ - 如果你需要开发一个文档站点,请移步至 [Modern.js Doc](https://modernjs.dev/doc-tools/zh) 文档。
22
+ - 如果你需要基于 Modern.js 的构建引擎来实现一个 Web 开发框架,请移步至 [Modern.js Builder](https://modernjs.dev/builder) 文档。
23
+
24
+ :::tip
25
+ 由于 Modern.js 框架的使用最为广泛,在本文档站中,我们会省略「框架」,直接称其为 Modern.js。
26
+ :::
27
+
28
+ ## Modern.js 框架
29
+
30
+ **Modern.js 框架是一个基于 React 的渐进式 Web 开发框架**。在字节跳动内部,我们将 Modern.js 封装为上层框架,并支撑了数千个 Web 应用的研发。
15
31
 
16
32
  Modern.js 能为开发者提供极致的**开发体验(Development Experience)**,让应用拥有更好的**用户体验(User Experience)**。
17
33
 
18
34
  在开发 React 应用过程中,开发者通常需要去为某些功能去设计实现方案,或是使用其他的库、框架来解决这些问题。Modern.js 支持 React 应用所需要的所有配置和工具,并内置**额外的功能和优化**。开发者可以使用 React 构建应用的 UI,然后逐步采用 Modern.js 的功能来解决常见的应用需求,如路由、数据获取、状态管理等。
19
35
 
20
- 它主要包含以下特点:
36
+ 它主要包含以下特性:
21
37
 
38
+ - 🚀 **Rust 构建**:提供双构建工具支持,轻松切换到 Rspack 构建工具,编译飞快。
22
39
  - 🪜 **渐进式**:使用最精简的模板创建项目,通过生成器逐步开启插件功能,定制解决方案。
23
40
  - 🏠 **一体化**:开发与生产环境 Web Server 唯一,CSR 和 SSR 同构开发,函数即接口的 API 服务调用。
24
41
  - 📦 **开箱即用**:默认 TS 支持,内置构建、ESLint、调试工具,全功能可测试。
25
42
  - 🌏 **周边生态**:自研状态管理、微前端、模块打包、Monorepo 方案等周边需求。
26
43
  - 🕸 **多种路由模式**:包含自控路由、基于文件约定的路由(嵌套路由)等。
27
- - 🚀 **独立构建核心**:支持多种打包工具,深度优化构建产物。
28
44
 
29
45
  ## 下一步
30
46
 
31
- 如果你希望了解如何使用 Modern.js,可以尝试 [创建第一个应用](/tutorials/first-app/c01-start),或是阅读 [快速上手](/guides/get-started/quick-start)。
47
+ 如果你希望了解如何使用 Modern.js 框架,可以尝试 [创建第一个应用](/tutorials/first-app/c01-start),或是阅读 [快速上手](/guides/get-started/quick-start)。