@modern-js/main-doc 2.25.2 → 2.27.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @modern-js/main-doc
 
+## 2.27.0
+
+### Patch Changes
+
+- 86274f5: docs: add source code build documentation
+  docs: 添加源码构建文档
+- ebdc4da: Fixed markdown error for link to styled-components website
+- Updated dependencies [86274f5]
+  - @modern-js/builder-doc@2.27.0
+
+## 2.26.0
+
+### Patch Changes
+
+- @modern-js/builder-doc@2.26.0
+
 ## 2.25.2
 
 ### Patch Changes

package/docs/en/components/prerequisites.mdx

@@ -9,7 +9,7 @@ import NodeVersion from '@modern-js/builder-doc/docs/en/shared/nodeVersion.md';
 It is recommended to use [pnpm](https://pnpm.io/installation) to manage dependencies:
 
 ```bash
-npm install -g pnpm@7
+npm install -g pnpm@8
 ```
 
 :::note

package/docs/en/configure/app/experiments/source-build.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: sourceBuild
+---
+
+# experiments.sourceBuild
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [experiments.sourceBuild](https://modernjs.dev/builder/en/api/config-experiments.html#experimentssourcebuild).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/experiments/sourceBuild.md';
+
+<Main />

package/docs/en/configure/app/server/ssr.mdx

@@ -32,14 +32,15 @@ When the value type is `Object`, the following properties can be configured:
 ```ts title="modern.config.ts"
 export default defineConfig({
   server: {
-    forceCSR: true,
-    mode: 'stream',
-    inlineScript: false,
+    ssr: {
+      forceCSR: true,
+      mode: 'stream',
+      inlineScript: false,
+    },
   },
 });
 ```
 
-
 ### Active Fallback
 
 In a production environment, there are scenarios where it is necessary to actively fallback an SSR project to CSR. Examples include
@@ -50,7 +51,7 @@ In a production environment, there are scenarios where it is necessary to active
 
 3. When the SSR server is under heavy load, it may be necessary to fallback some traffic directly to the CSR to avoid service downtime.
 
-By configuring `ssr.forCSR` to `true` in the project, you can control this behavior through query strings or request headers.
+By configuring `server.ssr.forceCSR` to `true` in the project, you can control this behavior through query strings or request headers.
 
 For example, in a custom Web Server middleware, you can actively fallback when traffic exceeds a certain threshold:
 

package/docs/en/configure/app/source/alias-strategy.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: aliasStrategy
+---
+
+# source.aliasStrategy
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [source.aliasStrategy](https://modernjs.dev/builder/en/api/config-source.html#sourcealiasstrategy).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/source/aliasStrategy.md';
+
+<Main />

package/docs/en/configure/app/tools/swc.mdx

@@ -15,11 +15,13 @@ import SWC from '@modern-js/builder-doc/docs/en/shared/swc.md';
 
 :::tip
 When using Rspack as the bundler, SWC will be used for transpiling and compression by default, so you don't need to install or configure the SWC plugin.
+
+If you have configured the current SWC plugin when using Rspack, it will not have any effect.
 :::
 
 ## Install
 
-import EnableSWC from '@modern-js/builder-doc/docs/en/shared/enable-swc.md';
+import EnableSWC from '@modern-js/builder-doc/docs/en/shared/enableSwc.md';
 
 <EnableSWC />
 

package/docs/en/guides/advanced-features/rspack-start.mdx

@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # Using Rspack
 
-import Rspack from '@modern-js/builder-doc/docs/en/shared/rspack-tip.mdx';
+import Rspack from '@modern-js/builder-doc/docs/en/shared/rspackTip.mdx';
 
 <Rspack />
 

package/docs/en/guides/get-started/quick-start.mdx

@@ -13,7 +13,7 @@ import Prerequisites from "@site-docs-en/components/prerequisites"
 
 ## Installation
 
-Modern.js provides the `@modern-js/create` tool to create projects. Do not install it globally, use `npx` to run it.
+Modern.js provides the `@modern-js/create` tool to create projects. It does not require global installation and can be run on-demand using `npx`.
 
 You can create a project in an existing empty directory:
 
@@ -47,21 +47,41 @@ In a Modern.js project created using `@modern-js/create`, a `modern.config.ts` f
 You can modify the configuration through this file to override the default behavior of Modern.js. For example, to enable SSR, add the following configuration:
 
 ```ts
-import { defineConfig } from '@modern-js/app-tools';
+import { appTools, defineConfig } from '@modern-js/app-tools';
 
 export default defineConfig({
   runtime: {
     router: true,
-    state: true,
   },
   server: {
     ssr: true,
   },
+  plugins: [appTools()],
 });
 ```
 
 After running `pnpm run dev` again, you can find that the project has completed page rendering on the server in the browser's Network menu.
 
+## Core npm Package
+
+In a newly created project, the `@modern-js/app-tools` npm package is installed by default. It is the core package of the Modern.js framework and provides the following capabilities:
+
+- It offers commonly used CLI commands such as `modern dev`, `modern build`, and more.
+- It integrates Modern.js Core, providing capabilities for configuration parsing, plugin loading, and more.
+- It integrates Modern.js Builder, providing build capabilities.
+- It integrates Modern.js Server, providing capabilities for development and production servers.
+- It integrates some commonly used plugins, such as `plugin-lint`, `plugin-data-loader`, and more.
+
+`@modern-js/app-tools` is implemented based on the plugin system of Modern.js. Essentially, it is a plugin. Therefore, you need to register `appTools` in the `plugins` field of the configuration file:
+
+```ts title="modern.config.ts"
+import { appTools, defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  plugins: [appTools()],
+});
+```
+
 ## Build the project
 
 To build the production artifacts of the project, run `pnpm run build` in the project: