@umijs/plugin-docs 4.0.0-beta.17

package/README.md

@@ -0,0 +1,3 @@
+# @umijs/plugin-docs
+
+See our website [umijs](https://umijs.org) for more information.

package/dist/compiler.d.ts

@@ -0,0 +1,8 @@
+export declare function compile(opts: {
+    content: string;
+}): Promise<{
+    result: any;
+    meta: {
+        title: any;
+    };
+}>;

package/dist/compiler.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compile = void 0;
+// @ts-ignore
+const mdx_1 = __importDefault(require("@mdx-js/mdx"));
+function compile(opts) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let result = yield (0, mdx_1.default)(opts.content, {
+            remarkPlugins: [],
+            rehypePlugins: [],
+            compilers: [],
+        });
+        result = `
+import React from 'react';
+${result}`;
+        result = result.replace('/* @jsxRuntime classic */', '');
+        result = result.replace('/* @jsx mdx */', '');
+        const title = result.match(/<h1>{`(.*?)`}<\/h1>/)[1];
+        result = `${result}\nMDXContent.title = '${title}';`;
+        return {
+            result,
+            meta: {
+                title,
+            },
+        };
+    });
+}
+exports.compile = compile;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { IApi } from 'umi';
+declare const _default: (api: IApi) => void;
+export default _default;

package/dist/index.js

@@ -0,0 +1,105 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importStar(require("fs"));
+const path_1 = require("path");
+const markdown_1 = require("./markdown");
+exports.default = (api) => {
+    api.modifyDefaultConfig((memo) => {
+        memo.conventionRoutes = Object.assign(Object.assign({}, memo.conventionRoutes), { base: (0, path_1.join)(api.cwd, 'docs') });
+        memo.mdx = {
+            loader: require.resolve('./loader'),
+            loaderOptions: {},
+        };
+        return memo;
+    });
+    api.addLayouts(() => {
+        return [
+            {
+                id: 'docs-layout',
+                file: withTmpPath({ api, path: 'Layout.tsx' }),
+            },
+        ];
+    });
+    api.onPatchRoute(({ route }) => {
+        if (route.__content) {
+            route.titles = (0, markdown_1.parseTitle)({
+                content: route.__content,
+            });
+        }
+        // 放在 docs/xxx.zh-CN.md 的文档，会被映射到 /zh-CN/docs/xxx 目录
+        if (route.file.match(/.[a-z]{2}-[A-Z]{2}.md$/)) {
+            route.path = route.path.replace(/(.*).([a-z]{2}-[A-Z]{2})$/, '$2/$1');
+            // 放在 docs/xxx/README.zh-CN.md 格式结尾的文档，会被映射到 /zh-CN/docs 目录
+            if (route.path.endsWith('README')) {
+                route.path = route.path.replace(/README$/, '');
+            }
+        }
+    });
+    api.onGenerateFiles(() => {
+        const themeConfigPath = (0, path_1.join)(api.cwd, 'theme.config.ts');
+        const themeExists = (0, fs_1.existsSync)(themeConfigPath);
+        // 将 docs/locales 目录下的 json 文件注入到 themeConfig.locales 中
+        let injectLocale = 'themeConfig.locales = {};';
+        const localesPath = (0, path_1.join)(api.cwd, 'docs/locales');
+        if ((0, fs_1.existsSync)(localesPath)) {
+            fs_1.default.readdirSync(localesPath).forEach((file) => {
+                if (file.endsWith('.json')) {
+                    const filePath = (0, path_1.join)(localesPath, file);
+                    const content = fs_1.default.readFileSync(filePath).toString();
+                    const json = JSON.parse(content);
+                    const localeName = file.replace('.json', '');
+                    injectLocale += `themeConfig.locales['${localeName}'] = ${JSON.stringify(json)};
+`;
+                }
+            });
+        }
+        api.writeTmpFile({
+            path: 'Layout.tsx',
+            content: `
+import React from 'react';
+import { useOutlet, useAppData, useLocation, Link } from 'umi';
+import { Layout } from '${require.resolve('../client/theme-doc')}';
+${themeExists
+                ? `import themeConfig from '${themeConfigPath}'`
+                : `const themeConfig = {}`}
+
+${injectLocale}
+
+export default () => {
+  const outlet = useOutlet();
+  const appData = useAppData();
+  const location = useLocation();
+  return (
+    <Layout appData={appData} components={{Link}} themeConfig={themeConfig} location={location}>
+      <div>{ outlet }</div>
+    </Layout>
+  );
+};
+    `,
+        });
+    });
+};
+function withTmpPath(opts) {
+    return (0, path_1.join)(opts.api.paths.absTmpPath, opts.api.plugin.key && !opts.noPluginDir
+        ? `plugin-${opts.api.plugin.key}`
+        : '', opts.path);
+}

package/dist/loader.d.ts

@@ -0,0 +1 @@
+export default function (content: string): Promise<any>;

package/dist/loader.js

@@ -0,0 +1,23 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const compiler_1 = require("./compiler");
+function default_1(content) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // @ts-ignore
+        const callback = this.async();
+        const { result } = yield (0, compiler_1.compile)({
+            content,
+        });
+        return callback(null, result);
+    });
+}
+exports.default = default_1;

package/dist/markdown.d.ts

@@ -0,0 +1,6 @@
+export declare function parseTitle(opts: {
+    content: string;
+}): {
+    level: number;
+    title: string;
+}[];

package/dist/markdown.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTitle = void 0;
+function parseTitle(opts) {
+    const lines = opts.content.split('\n');
+    let i = 0;
+    const ret = [];
+    while (i < lines.length) {
+        const line = lines[i].trim();
+        const match = line.match(/^(#+)\s+(.*)/);
+        if (match) {
+            ret.push({
+                level: match[1].length,
+                title: match[2],
+            });
+        }
+        i += 1;
+    }
+    return ret;
+}
+exports.parseTitle = parseTitle;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@umijs/plugin-docs",
+  "version": "4.0.0-beta.17",
+  "description": "@umijs/plugin-docs",
+  "homepage": "https://github.com/umijs/umi-next/tree/master/packages/plugin-docs#readme",
+  "bugs": "https://github.com/umijs/umi-next/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/umijs/umi-next"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pnpm tsc",
+    "build:css": "tailwindcss -i ./client/theme-doc/tailwind.css -o ./client/theme-doc/tailwind.out.css",
+    "build:deps": "pnpm esno ../../scripts/bundleDeps.ts",
+    "dev": "pnpm build -- --watch"
+  },
+  "dependencies": {
+    "@mdx-js/mdx": "1.6.22",
+    "classnames": "^2.3.1"
+  },
+  "devDependencies": {
+    "tailwindcss": "^3.0.15",
+    "umi": "4.0.0-beta.17"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "authors": [
+    "chencheng <sorrycc@gmail.com> (https://github.com/sorrycc)"
+  ]
+}