npm - @modern-js/main-doc - Versions diffs - 2.67.5 → 2.67.7 - Mend

@modern-js/main-doc 2.67.5 → 2.67.7

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 (208) hide show

package/docs/zh/configure/app/html/app-icon.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: appIcon
-configName: html.appIcon
 ---
 # html.appIcon
@@ -50,6 +49,6 @@ export default {
 };
 ```
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.appIcon" />

package/docs/zh/configure/app/html/crossorigin.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: crossorigin
-configName: html.crossorigin
 ---
 # html.crossorigin
@@ -11,6 +10,6 @@ configName: html.crossorigin
 用于设置 `<script>` 和 `<style>` 标签的 [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin) 属性。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.crossorigin" />

package/docs/zh/configure/app/html/favicon.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: favicon
-configName: html.favicon
 ---
 # html.favicon
@@ -17,6 +16,6 @@ configName: html.favicon
 配置该选项后，在编译过程中会自动将图标拷贝至 dist 目录下，并在 HTML 中添加相应的 `link` 标签。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.favicon" />

package/docs/zh/configure/app/html/inject.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: inject
-configName: html.inject
 ---
 # html.inject
@@ -10,6 +9,6 @@ configName: html.inject
 修改构建产物中 `<script>` 标签在 HTML 中的插入位置。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.inject" />

package/docs/zh/configure/app/html/meta.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: meta
-configName: html.meta
 ---
 # html.meta
@@ -24,6 +23,6 @@ const defaultMeta = {
 配置 HTML 页面的 `<meta>` 标签。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.meta" />

package/docs/zh/configure/app/html/mount-id.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: mountId
-configName: html.mountId
 ---
 # html.mountId
@@ -10,6 +9,6 @@ configName: html.mountId
 默认情况下，HTML 模板中包含了 `root` 节点用于组件挂载，通过 `mountId` 可以修改该节点的 id。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.mountId" />

package/docs/zh/configure/app/html/output-structure.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: outputStructure
-configName: html.outputStructure
 ---
 # html.outputStructure
@@ -10,6 +9,6 @@ configName: html.outputStructure
 用于定义 HTML 产物文件的目录结构。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.outputStructure" />

package/docs/zh/configure/app/html/script-loading.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: scriptLoading
-configName: html.scriptLoading
 ---
 # html.scriptLoading
@@ -10,6 +9,6 @@ configName: html.scriptLoading
 用于设置 `<script>` 标签的加载方式。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.scriptLoading" />

package/docs/zh/configure/app/html/tags.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: tags
-configName: html.tags
 ---
 # html.tags
@@ -15,6 +14,6 @@ type TagsConfig = HtmlTag | HtmlTagHandler | Array<HtmlTag | HtmlTagHandler>;
 添加和修改最终注入到 HTML 页面的标签。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.tags" />

package/docs/zh/configure/app/html/template-parameters.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: templateParameters
-configName: html.templateParameters
 ---
 # html.templateParameters
@@ -33,6 +32,6 @@ type DefaultParameters = {
 定义 HTML 模板中的参数，对应 [html-rspack-plugin](https://github.com/rspack-contrib/html-rspack-plugin) 的 `templateParameters` 配置项。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.templateParameters" />

package/docs/zh/configure/app/html/template.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: template
-configName: html.template
 ---
 # html.template
@@ -10,6 +9,6 @@ configName: html.template
 定义 HTML 模板的文件路径，可以是相对路径或绝对路径。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.template" />

package/docs/zh/configure/app/html/title.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: title
-configName: html.title
 ---
 # html.title
@@ -18,6 +17,6 @@ export default {
 };
 ```
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="html.title" />

package/docs/zh/configure/app/output/asset-prefix.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: assetPrefix
-configName: output.assetPrefix
 ---
 # output.assetPrefix
@@ -14,6 +13,6 @@ import OutputAssetPrefixExtend from '@site-docs/components/output-asset-prefix-e
 <OutputAssetPrefixExtend />
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.assetPrefix" />

package/docs/zh/configure/app/output/charset.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: charset
-configName: output.charset
 ---
 # output.charset
@@ -10,6 +9,6 @@ configName: output.charset
 `charset` 配置项允许你指定输出文件的[字符编码](https://developer.mozilla.org/en-US/docs/Glossary/Character_encoding) 字符编码，以确保它们在不同的环境中能够正确显示。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.charset" />

package/docs/zh/configure/app/output/copy.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: copy
-configName: output.copy
 ---
 # output.copy
@@ -10,6 +9,6 @@ configName: output.copy
 将指定的文件或目录拷贝到构建输出目录中，基于 [rspack.CopyRspackPlugin](https://rspack.dev/zh/plugins/rspack/copy-rspack-plugin) 实现。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.copy" />

package/docs/zh/configure/app/output/css-modules.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: cssModules
-configName: output.cssModules
 ---
 # output.cssModules
@@ -48,6 +47,6 @@ const defaultCssModules = {
 自定义 CSS 模块配置。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.cssModules" />

package/docs/zh/configure/app/output/data-uri-limit.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: dataUriLimit
-configName: output.dataUriLimit
 ---
 # output.dataUriLimit
@@ -26,6 +25,6 @@ const defaultDatUriLimit = 10000;
 设置图片、字体、媒体等静态资源被自动内联为 base64 的体积阈值。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.dataUriLimit" />

package/docs/zh/configure/app/output/dist-path.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: distPath
-configName: output.distPath
 ---
 # output.distPath
@@ -18,7 +17,6 @@ type DistPathConfig = {
   wasm?: string;
   image?: string;
   media?: string;
-  server?: string;
   worker?: string;
   assets?: string;
 };
@@ -43,6 +41,6 @@ const defaultDistPath = {
 设置构建产物的输出目录，Modern.js 会根据产物的类型输出到对应的子目录下。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.distPath" />

package/docs/zh/configure/app/output/externals.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: externals
-configName: output.externals
 ---
 # output.externals
@@ -20,6 +19,6 @@ type Externals =
 在构建时，防止将代码中某些 `import` 的依赖包打包到 bundle 中，而是在运行时再去从外部获取这些依赖。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.externals" />

package/docs/zh/configure/app/output/filename-hash.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: filenameHash
-configName: output.filenameHash
 ---
 # output.filenameHash
@@ -10,6 +9,6 @@ configName: output.filenameHash
 在生产模式构建后，是否在产物的文件名中添加 hash 值。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.filenameHash" />

package/docs/zh/configure/app/output/filename.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: filename
-configName: output.filename
 ---
 :::warning
@@ -60,6 +59,6 @@ const prodDefaultFilename = {
 设置构建产物的名称。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.filename" />

package/docs/zh/configure/app/output/inject-styles.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: injectStyles
-configName: output.injectStyles
 ---
 # output.injectStyles
@@ -10,6 +9,6 @@ configName: output.injectStyles
 是否将 CSS 样式插入到 DOM 中。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.injectStyles" />

package/docs/zh/configure/app/output/inline-scripts.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: inlineScripts
-configName: output.inlineScripts
 ---
 # output.inlineScripts
@@ -29,6 +28,6 @@ type InlineScripts =
 当使用约定式路由时，如果开启了这个选项，需要将 [output.splitRouteChunks](/configure/app/output/split-route-chunks) 设置为 false。
 :::
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.inlineScripts" />

package/docs/zh/configure/app/output/inline-styles.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: inlineStyles
-configName: output.inlineStyles
 ---
 # output.inlineStyles
@@ -29,6 +28,6 @@ type InlineStyles =
 当使用约定式路由时，如果开启了这个选项，需要将 [output.splitRouteChunks](/configure/app/output/split-route-chunks) 设置为 false。
 :::
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.inlineStyles" />

package/docs/zh/configure/app/output/legal-comments.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: legalComments
-configName: output.legalComments
 ---
 # output.legalComments
@@ -18,6 +17,6 @@ legal comment 是 JS 或 CSS 文件中的一些特殊注释，这些注释包含
 - `inline`：保留所有 legal comments。
 - `none`：移除所有 legal comments。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.legalComments" />

package/docs/zh/configure/app/output/minify.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: minify
-configName: output.minify
 ---
 # output.minify
@@ -22,6 +21,6 @@ type Minify =
 用于设置是否在生产模式下开启代码压缩，或是配置压缩工具的选项。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.minify" />

package/docs/zh/configure/app/output/override-browserslist.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: overrideBrowserslist
-configName: output.overrideBrowserslist
 ---
 # output.overrideBrowserslist
@@ -22,6 +21,6 @@ const defaultBrowserListMap: Record<RsbuildTarget, string[]> = {
 Modern.js 会优先使用项目根目录的 `.browserslistrc` 文件中的配置。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.overrideBrowserslist" />

package/docs/zh/configure/app/output/polyfill.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: polyfill
-configName: output.polyfill
 ---
 # output.polyfill
@@ -14,6 +13,6 @@ import OutputPolyfillExtend from '@site-docs/components/output-polyfill-extend';
 <OutputPolyfillExtend />
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.polyfill" />

package/docs/zh/configure/app/output/source-map.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: sourceMap
-configName: output.sourceMap
 ---
 # output.sourceMap
@@ -27,6 +26,6 @@ const defaultSourceMap = {
 用于设置是否生成 source map 文件，以及生成哪一种格式的 source map。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="output.sourceMap" />

package/docs/zh/configure/app/performance/build-cache.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: buildCache
-configName: performance.buildCache
 ---
 # performance.buildCache
@@ -41,6 +40,6 @@ export default {
 需要注意的是，Rspack 的持久化缓存处于[实验性阶段](https://rspack.dev/zh/config/experiments#experimentscache)，可能会在未来的版本中发生变化，该功能需要手动开启。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.buildCache" />

package/docs/zh/configure/app/performance/bundle-analyze.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: bundleAnalyze
-configName: performance.bundleAnalyze
 ---
 # performance.bundleAnalyze
@@ -20,6 +19,6 @@ const defaultConfig = {
 };
 ```
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.bundleAnalyze" />

package/docs/zh/configure/app/performance/chunk-split.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: chunkSplit
-configName: performance.chunkSplit
 ---
 # performance.chunkSplit
@@ -40,6 +39,6 @@ interface SplitCustom {
 export type ChunkSplit = BaseChunkSplit | SplitBySize | SplitCustom;
 ```
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.chunkSplit" />

package/docs/zh/configure/app/performance/dns-prefetch.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: dnsPrefetch
-configName: performance.dnsPrefetch
 ---
 # performance.dnsPrefetch
@@ -15,6 +14,6 @@ configName: performance.dnsPrefetch
 更多信息可参考：[Using dns-prefetch](https://developer.mozilla.org/en-US/docs/Web/Performance/dns-prefetch)
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.dnsPrefetch" />

package/docs/zh/configure/app/performance/preconnect.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: preconnect
-configName: performance.preconnect
 ---
 # performance.preconnect
@@ -16,6 +15,6 @@ interface PreconnectOption {
 - **默认值：** `undefined`
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.preconnect" />

package/docs/zh/configure/app/performance/prefetch.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: prefetch
-configName: performance.prefetch
 ---
 # performance.prefetch
@@ -21,6 +20,6 @@ interface PrefetchOption {
 - **默认值：** `undefined`
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.prefetch" />

package/docs/zh/configure/app/performance/preload.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: preload
-configName: performance.preload
 ---
 # performance.preload
@@ -23,6 +22,6 @@ interface PreloadOption {
 为 Rsbuild 构建生成的静态资源注入 [`<link rel="preload">`](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Attributes/rel/preload) 标签。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.preload" />

package/docs/zh/configure/app/performance/print-file-size.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: printFileSize
-configName: performance.printFileSize
 ---
 # performance.printFileSize
@@ -40,6 +39,6 @@ info    Production file sizes:
   dist/static/css/main.03221f72.css         1.4 kB       741 B
 ```
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.printFileSize" />

package/docs/zh/configure/app/performance/profile.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: profile
-configName: performance.profile
 ---
 # performance.profile
@@ -10,6 +9,6 @@ configName: performance.profile
 是否捕获每个模块的耗时信息，对应 Rspack 的 [profile](https://webpack.js.org/configuration/other-options/#profile) 配置。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.profile" />

package/docs/zh/configure/app/performance/remove-console.mdx CHANGED Viewed

@@ -1,6 +1,5 @@
 ---
 title: removeConsole
-configName: performance.removeConsole
 ---
 # performance.removeConsole
@@ -10,6 +9,6 @@ configName: performance.removeConsole
 在生产环境构建时，是否自动移除代码中的 `console.[methodName]`。
-import RsbuildConig from '@site-docs/components/rsbuild-config-tooltip';
+import RsbuildConfig from '@site-docs/components/rsbuild-config-tooltip';
-<RsbuildConig />
+<RsbuildConfig configName="performance.removeConsole" />