fix: not generate demo pages (#542)

* fix: transfrom mjs to mts

* fix: source name

* chore: upgrade example @swc/helpers

* fix: alias parser

* fix: not generate demo pages in monorepo

* chore: changelog

* docs: update path

Author: luhc228

.changeset/late-goats-fly.md

@@ -0,0 +1,5 @@
+---
+'@ice/pkg-plugin-docusaurus': patch
+---
+
+fix: not generate demo pages in monorepo

packages/plugin-docusaurus/src/constants.mts

@@ -1,3 +1,4 @@
 export const DOCUSAURUS_DIR = '.docusaurus';
 export const DOCUSAURUS_CONFIG_FILE = 'docusaurus.config.cjs';
 export const DOCUSAURUS_BABEL_CONFIG_FILE = 'babel.config.js';
+export const DEFAULT_DEV_SERVER_PORT = 4000;

packages/plugin-docusaurus/src/genDemoPages/index.mts

@@ -7,9 +7,9 @@ import getExtractCodePlugin from './extractCodePlugin.mjs';
 import parse from 'remark-parse';
 import stringify from 'remark-stringify';
 
-function scanDocsDirectory(rootDir: string): DirectoryTree | null {
-  const docsDir = path.join(rootDir, 'docs');
-  const tree = directoryTree.default(docsDir, { extensions: /\.md$/ });
+function scanDocsDirectory(rootDir: string, docsPath: string): DirectoryTree | null {
+  const docsDir = path.join(rootDir, docsPath);
+  const tree = directoryTree.default(docsDir, { extensions: /\.mdx?$/ });
   return tree;
 }
 
@@ -28,8 +28,8 @@ function extractCodeFromDocs(docsTree: DirectoryTree, rootDir: string): void {
   });
 }
 
-export default function genDemoPages(rootDir: string): void {
-  const docsTree = scanDocsDirectory(rootDir);
+export default function genDemoPages(rootDir: string, docsPath: string): void {
+  const docsTree = scanDocsDirectory(rootDir, docsPath);
   if (docsTree) {
     extractCodeFromDocs(docsTree, rootDir);
   }

packages/plugin-docusaurus/src/index.mts

@@ -1,11 +1,11 @@
+import fse from 'fs-extra';
 import { doc } from './doc.mjs';
 import { configureDocusaurus } from './configureDocusaurus.mjs';
 import genDemoPages from './genDemoPages/index.mjs';
+import { DEFAULT_DEV_SERVER_PORT, DOCUSAURUS_DIR } from './constants.mjs';
 import type { EnableConfig, PluginDocusaurusOptions } from './types.mjs';
 import type { Plugin } from '@ice/pkg';
 
-const DEFAULT_DEV_SERVER_PORT = 4000;
-
 const defaultOptions: PluginDocusaurusOptions = {
   title: 'ICE PKG',
   url: 'https://your-docusaurus-test-site.com',
@@ -30,6 +30,8 @@ const plugin: Plugin = (api, options: PluginDocusaurusOptions = {}) => {
     return;
   }
 
+  fse.removeSync(DOCUSAURUS_DIR);
+
   const configuredPlugins = getAllPlugin();
   const pluginOptions = {
     ...defaultOptions,
@@ -45,7 +47,7 @@ const plugin: Plugin = (api, options: PluginDocusaurusOptions = {}) => {
     if (command === 'build') {
       // Pages must be generated before build
       // because remark plugin of docusaurus-plugin-content-docs works after docusaurus-plugin-content-pages reads the pages dir
-      genDemoPages(rootDir);
+      genDemoPages(rootDir, pluginOptions.path);
     }
     await doc(api, pluginOptions);
   });

website/docs/guide/preview.md

@@ -625,6 +625,13 @@ export default defineConfig({
 
 配置 Docusaurus 构建产物输出地址。
 
+#### path
+
+- 类型：`string`
+- 默认值：`'docs'`
+
+存放文档的目录，将会扫描该目录下所有的 `.md` 和 `.mdx` 文件并生成文档页面。相关规则说明详见[文档](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#path)。
+
 #### docsRouteBasePath
 
 - 类型：`string`
@@ -642,7 +649,7 @@ export default defineConfig({
 - 类型：`string`
 - 默认值：`'pages'`
 
-存放页面的本地路径。默认是项目根目录的 `pages` 目录。页面路由规则详见[文档](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages#path)。
+存放页面的目录，该目录下的组件将会自动生成为页面，一个组件的文件路径会被映射生成对应的路由。页面路由规则详见[文档](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-pages#path)。
 
 #### pageRouteBasePath