@modern-js/main-doc 2.16.0 → 2.17.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @modern-js/main-doc
 
+## 2.17.1
+
+### Patch Changes
+
+- fc76194: chore: comment the doc for runtime and server plugin hooks
+  chore: 注释 runtime 和 server 插件钩子文档
+- 7d899fb: fix: typo isFileExist
+
+  fix: isFileExist 拼写错误
+
+  - @modern-js/builder-doc@2.17.1
+
+## 2.17.0
+
+### Patch Changes
+
+- @modern-js/builder-doc@2.17.0
+
 ## 2.16.0
 
 ### Patch Changes

package/docs/en/community/blog/_category_.json

@@ -0,0 +1,6 @@
+{
+  "label": "Blog",
+  "position": 4,
+  "collapsed": false,
+  "collapsible": false
+}

package/docs/en/{blog/index.md → community/blog/overview.md}

@@ -2,7 +2,9 @@
 sidebar_position: 1
 ---
 
-# Blog
+# Overview
+
+Welcome to the Modern.js blog!
 
 You can find the latest news about Modern.js here.
 

package/docs/en/guides/topic-detail/framework-plugin/hook-list.mdx

@@ -611,7 +611,7 @@ export default (): CliPlugin => ({
 
 This adds a new Script tag to the HTML template.
 
-## Server
+<!-- ## Server
 
 :::note
 The Server plugin is currently not fully opened, and the API is not guaranteed to be stable. Use with caution.
@@ -691,7 +691,7 @@ export default (): ServerPlugin => ({
     };
   },
 });
-```
+``` -->
 
 ## Runtime
 
@@ -699,7 +699,7 @@ export default (): ServerPlugin => ({
 The Runtime plugin is currently not fully opened, and the API is not guaranteed to be stable. Use with caution.
 :::
 
-The Runtime plugin is mainly used for developers to modify the components and elements that need to be rendered, and customize the rendering process on the server and client side.
+The Runtime plugin is mainly used for developers to modify the component that need to be rendered.
 
 ### `init`
 
@@ -732,23 +732,29 @@ export default (): Plugin => ({
 - Type: `Pipeline<{ App: React.ComponentType<any>; }, React.ComponentType<any>>`
 - Usage Example:
 
+:::note
+When using the hoc hook, you need to copy the static properties of the original App component to the new component and pass through the props.
+:::
+
 ```ts
 import { createContext } from 'react';
 import type { Plugin } from '@modern-js/runtime';
+import hoistNonReactStatics from 'hoist-non-react-statics';
 
 export default (): Plugin => ({
   setup(api) {
     const FooContext = createContext('');
     return {
       hoc({ App }, next) {
+        const AppWrapper = (props: any) => {
+          return (
+            <FooContext.Provider store={'test'}>
+              <App {...props} />
+            </FooContext.Provider>
+          );
+        };
         return next({
-          App: (props: any) => {
-            return (
-              <FooContext.Provider store={'test'}>
-                <App {...props} />
-              </FooContext.Provider>
-            );
-          },
+          App: hoistNonReactStatics(AppWrapper, App)
         });
       },
     };
@@ -756,7 +762,7 @@ export default (): Plugin => ({
 });
 ```
 
-### `provide`
+<!-- ### `provide`
 
 - Function: Modifies the Elements that need to be rendered.
 - Execution Stage: Rendering (SSR/CSR).
@@ -828,4 +834,4 @@ export default (): Plugin => ({
     };
   },
 });
-```
+``` -->

package/docs/en/guides/topic-detail/generator/plugin/api/info/isFileExit.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# isFileExit
+# isFileExist
 
 Determine if the file exists.
 
@@ -12,7 +12,7 @@ Its type is defined as:
 
 ```ts
 export interface IPluginContext {
-  isFileExit: (fileName: string) => Promise<boolean>;
+  isFileExist: (fileName: string) => Promise<boolean>;
   ...
 }
 ```

package/docs/zh/community/blog/_category_.json

@@ -0,0 +1,6 @@
+{
+  "label": "博客",
+  "position": 4,
+  "collapsed": false,
+  "collapsible": false
+}

package/docs/zh/{blog/index.md → community/blog/overview.md}

@@ -2,7 +2,9 @@
 sidebar_position: 1
 ---
 
-# 博客
+# 总览
+
+欢迎来到 Modern.js 博客频道！
 
 在这里，你可以了解到 Modern.js 的最新进展和技术分享。
 
@@ -18,7 +20,7 @@ Modern.js 是字节跳动 Web Infra 团队开源的一套 Web 工程体系。在
 
 在这篇文章里，我们会和大家一起聊一聊 Modern.js 在过去一年多时间里的变化。
 
-[了解更多 →](/blog/updates/v2-release-note)
+[了解更多 →](/community/blog/v2-release-note)
 
 ---
 
@@ -56,7 +58,7 @@ Modern.js 9 ~ 10 月的最新版本为 v1.21.0，本双月的主要更新有：
 - **支持 pnpm v7**：完成框架对 pnpm v7 的支持。
 - **服务端增加 Typescript 作为 ts 文件编译器**。
 
-[了解更多 →](/blog/updates/2022-0910-updates)
+[了解更多 →](/community/blog/2022-0910-updates)
 
 ---
 
@@ -71,4 +73,4 @@ Modern.js 7 ~ 8 月的最新版本为 v1.17.0，本双月的主要更新有：
 - **模块工程支持 bundle 构建**：模块工程类型的项目，支持对产物做 bundle 构建。
 - **Reduck v1.1**：发布 Reduck v1.1，使用文档全面更新。
 
-[了解更多 →](/blog/updates/2022-0708-updates)
+[了解更多 →](/community/blog/2022-0708-updates)

package/docs/zh/guides/topic-detail/framework-plugin/hook-list.mdx

@@ -611,7 +611,7 @@ export default (): CliPlugin => ({
 
 这样就为 HTML 模版中新增了一个 Script 标签。
 
-## Server
+<!-- ## Server
 
 :::note
 目前 Server 插件还未完全开放，API 不保证稳定，使用需谨慎。
@@ -692,7 +692,7 @@ export default (): ServerPlugin => ({
     };
   },
 });
-```
+``` -->
 
 ## Runtime
 
@@ -701,7 +701,7 @@ export default (): ServerPlugin => ({
 
 :::
 
-Runtime 插件主要用于开发者修改需要渲染的组件与 Element 和定制服务器端、客户端的渲染过程。
+Runtime 插件主要用于开发者修改需要渲染的组件。
 
 ### `init`
 
@@ -734,23 +734,29 @@ export default (): Plugin => ({
 - 类型：`Pipeline<{ App: React.ComponentType<any>; }, React.ComponentType<any>>`
 - 使用示例：
 
+:::note
+使用 hoc 钩子时，需要把原来的 App 组件的静态属性拷贝到新的组件上，并透传 props.
+:::
+
 ```ts
 import { createContext } from 'react';
 import type { Plugin } from '@modern-js/runtime';
+import hoistNonReactStatics from 'hoist-non-react-statics';
 
 export default (): Plugin => ({
   setup(api) {
     const FooContext = createContext('');
     return {
       hoc({ App }, next) {
+        const AppWrapper = (props: any) => {
+          return (
+            <FooContext.Provider store={'test'}>
+              <App {...props} />
+            </FooContext.Provider>
+          );
+        };
         return next({
-          App: (props: any) => {
-            return (
-              <FooContext.Provider store={'test'}>
-                <App {...props} />
-              </FooContext.Provider>
-            );
-          },
+          App: hoistNonReactStatics(AppWrapper, App)
         });
       },
     };
@@ -758,7 +764,7 @@ export default (): Plugin => ({
 });
 ```
 
-### `provide`
+<!-- ### `provide`
 
 - 功能：修改需要渲染的 Element
 - 执行阶段：渲染（SSR/CSR）
@@ -830,4 +836,4 @@ export default (): Plugin => ({
     };
   },
 });
-```
+``` -->

package/docs/zh/guides/topic-detail/generator/plugin/api/info/isFileExit.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# isFileExit
+# isFileExist
 
 判断文件是否存在。
 
@@ -12,7 +12,7 @@ sidebar_position: 2
 
 ```ts
 export interface IPluginContext {
-  isFileExit: (fileName: string) => Promise<boolean>;
+  isFileExist: (fileName: string) => Promise<boolean>;
   ...
 }
 ```

package/modern.config.ts

@@ -7,8 +7,7 @@ const rootCategories = [
   'guides',
   'apis/app',
   'configure/app',
-  'blog',
-  'about',
+  'community',
 ];
 
 const { version } = require('./package.json');
@@ -42,14 +41,9 @@ const getNavbar = (lang: string): NavItem[] => {
       activeMatch: '/apis/',
     },
     {
-      text: getText('博客', 'Blog'),
-      link: getLink('/blog/index'),
-      activeMatch: '/blog/',
-    },
-    {
-      text: getText('关于', 'About'),
-      link: getLink('/about/showcase'),
-      activeMatch: '/about/',
+      text: getText('社区', 'Community'),
+      link: getLink('/community/showcase'),
+      activeMatch: '/community/',
     },
     {
       text: `v${version}`,
@@ -122,6 +116,11 @@ export default defineConfig({
           label: 'English',
         },
       ],
+      editLink: {
+        docRepoBaseUrl:
+          'https://github.com/web-infra-dev/modern.js/tree/main/packages/document/main-doc/docs',
+        text: 'Edit this page on GitHub',
+      },
       socialLinks: [
         {
           icon: 'github',

package/package.json

@@ -15,13 +15,13 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.16.0",
+  "version": "2.17.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "^2.16.0"
+    "@modern-js/builder-doc": "^2.17.1"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -33,9 +33,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "2.16.0",
-    "@modern-js/doc-tools": "2.16.0",
-    "@modern-js/doc-plugin-auto-sidebar": "2.16.0"
+    "@modern-js/builder-doc": "2.17.1",
+    "@modern-js/doc-tools": "2.17.1",
+    "@modern-js/doc-plugin-auto-sidebar": "2.17.1"
   },
   "scripts": {
     "dev": "modern dev",

package/docs/zh/blog/updates/_category_.json

@@ -1,5 +0,0 @@
-{
-  "label": "更新内容",
-  "position": 2,
-  "collapsed": false
-}