@modern-js/main-doc 0.0.0-next-1678939088213 → 0.0.0-next-1679037277335

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

@@ -2,6 +2,7 @@
 title: 插件 API
 sidebar_position: 6
 ---
+
 # 插件 API
 
 插件的 `setup` 函数会接收一个 `api` 入参，你可以调用 api 上提供的一些方法来获取到配置、应用上下文等信息。
@@ -36,16 +37,39 @@ interface UserConfig {
   source?: SourceConfig;
   output?: OutputConfig;
   server?: ServerConfig;
-  dev?: DevConfig;
   deploy?: DeployConfig;
-  tools?: ToolsConfig;
-  plugins?: PluginConfig;
-  runtime?: RuntimeConfig;
-  runtimeByEntries?: RuntimeByEntriesConfig;
+  // ...other fields
+}
+```
+
+具体配置字段的意义请参考 [配置](/configure/app/usage)。
+
+:::tip
+该方法获取到的是只读配置，不可修改。如果需要修改配置，请使用 [config hook](/guides/topic-detail/framework-plugin/hook-list.html#config)。
+:::
+
+### useResolvedConfigContext
+
+用于获取被解析、合并之后的最终配置。
+
+```ts
+const useResolvedConfigContext: () => NormalizedConfig;
+
+interface NormalizedConfig {
+  source: NormalizedSourceConfig;
+  output: NormalizedOutputConfig;
+  server: NormalizedServerConfig;
+  deploy: NormalizedDeployConfig;
+  _raw: UserConfig; // 原始配置对象
+  // ...other fields
 }
 ```
 
-具体配置字段的意义请参考【[配置](/configure/app/usage)】。
+配置字段的完整内容请参考 [配置](/configure/app/usage)。
+
+:::tip
+该方法获取到的是只读配置，不可修改。如果需要修改配置，请使用 [config hook](/guides/topic-detail/framework-plugin/hook-list.html#config)。
+:::
 
 ### useAppContext
 
@@ -75,29 +99,6 @@ interface IAppContext {
 }
 ```
 
-### useResolvedConfigContext
-
-用于获取解析之后的最终配置。
-
-```ts
-const useResolvedConfigContext: () => NormalizedConfig;
-
-interface NormalizedConfig {
-  source: NormalizedSourceConfig;
-  output: OutputConfig;
-  server: ServerConfig;
-  dev: DevConfig;
-  deploy: DeployConfig;
-  tools: NormalizedToolsConfig;
-  plugins: PluginConfig;
-  runtime: RuntimeConfig;
-  runtimeByEntries?: RuntimeByEntriesConfig;
-  _raw: UserConfig;
-}
-```
-
-具体配置字段的意义请参考【[配置](/configure/app/usage)】。
-
 ### useHookRunners
 
 用于获取 Hooks 的执行器，并触发特定的 Hook 执行。

package/modern.config.ts

@@ -40,12 +40,11 @@ const getNavbar = (lang: string): NavItem[] => {
       link: getLink('/apis/app/commands'),
       activeMatch: '/apis/',
     },
-    // TODO enabled after we write the v2 release blog
-    // {
-    //   text: getText('博客', 'Blog'),
-    //   link: getLink('/blog/index'),
-    //   activeMatch: '/blog/',
-    // },
+    {
+      text: getText('博客', 'Blog'),
+      link: getLink('/blog/index'),
+      activeMatch: '/blog/',
+    },
     {
       text: `v${version}`,
       items: [

package/package.json

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

package/src/pages/index.tsx

@@ -1,5 +1,6 @@
 import clsx from 'clsx';
-import { useLang, Helmet } from '@modern-js/doc-tools/runtime';
+import { useLang, Helmet, useLocation } from '@modern-js/doc-tools/runtime';
+import { useEffect } from 'react';
 import ContentCard from '../components/ContentCard';
 import SecondaryTitle from '../components/SecondaryTitle';
 import { FeatureLayout } from '../components/FeatureLayout';
@@ -44,6 +45,13 @@ const HomepageHeader = () => {
 
 export default function Home() {
   const t = useI18n();
+  const { pathname } = useLocation();
+  useEffect(() => {
+    window.MODERN_THEME = 'dark';
+    return () => {
+      window.MODERN_THEME = undefined;
+    };
+  }, [pathname]);
 
   const features = [
     {
@@ -106,10 +114,7 @@ export default function Home() {
     <div>
       <Helmet>
         <html className="dark"></html>
-        <script>
-          localStorage && localStorage.setItem('modern-theme-appearance',
-          'dark');
-        </script>
+        <script>window.MODERN_THEME = 'dark';</script>
         <style type="text/css">{`
           .modern-doc-appearance {
             display: none!important;

package/en/configure/app/dev/asset-prefix.mdx

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

package/en/configure/app/dev/before-start-url.mdx

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

package/en/configure/app/dev/hmr.mdx

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

package/en/configure/app/dev/host.mdx

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

package/en/configure/app/dev/https.mdx

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

package/en/configure/app/dev/port.mdx

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

package/en/configure/app/dev/progress-bar.mdx

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

package/en/configure/app/dev/start-url.mdx

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

package/en/configure/app/experiments/lazy-compilation.mdx

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

package/en/configure/app/html/app-icon.mdx

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

package/en/configure/app/html/crossorigin.mdx

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

package/en/configure/app/html/disable-html-folder.mdx

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

package/en/configure/app/html/favicon-by-entries.mdx

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

package/en/configure/app/html/favicon.mdx

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

package/en/configure/app/html/inject-by-entries.mdx

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

package/en/configure/app/html/inject.mdx

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

package/en/configure/app/html/meta-by-entries.mdx

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

package/en/configure/app/html/meta.mdx

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

package/en/configure/app/html/mount-id.mdx

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

package/en/configure/app/html/tags-by-entries.mdx

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

package/en/configure/app/html/tags.mdx

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

package/en/configure/app/html/template-by-entries.mdx

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

package/en/configure/app/html/template-parameters-by-entries.mdx

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

package/en/configure/app/html/template-parameters.mdx

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

package/en/configure/app/html/template.mdx

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

package/en/configure/app/html/title-by-entries.mdx

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

package/en/configure/app/html/title.mdx

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

package/en/configure/app/output/asset-prefix.mdx

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

package/en/configure/app/output/assets-retry.mdx

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

package/en/configure/app/output/charset.mdx

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

package/en/configure/app/output/clean-dist-path.mdx

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

package/en/configure/app/output/convert-to-rem.mdx

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

package/en/configure/app/output/copy.mdx

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

package/en/configure/app/output/css-module-local-ident-name.mdx

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