@docusaurus/mdx-loader 2.0.0-beta.fc64c12e4 → 2.0.0

package/lib/index.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { mdxLoader } from './loader';
+export default mdxLoader;
+export declare type TOCItem = {
+    readonly value: string;
+    readonly id: string;
+    readonly level: number;
+};
+export declare type LoadedMDXContent<FrontMatter, Metadata, Assets = undefined> = {
+    /** As verbatim declared in the MDX document. */
+    readonly frontMatter: FrontMatter;
+    /** As provided by the content plugin. */
+    readonly metadata: Metadata;
+    /** A list of TOC items (headings). */
+    readonly toc: readonly TOCItem[];
+    /** First h1 title before any content. */
+    readonly contentTitle: string | undefined;
+    /**
+     * Usually image assets that may be collocated like `./img/thumbnail.png`.
+     * The loader would also bundle these assets and the client should use these
+     * in priority.
+     */
+    readonly assets: Assets;
+    (): JSX.Element;
+};
+export type { Options, MDXPlugin, MDXOptions } from './loader';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAC,MAAM,UAAU,CAAC;AAEnC,eAAe,SAAS,CAAC;AAEzB,oBAAY,OAAO,GAAG;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,gBAAgB,CAAC,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,IAAI;IACxE,gDAAgD;IAChD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,sCAAsC;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,OAAO,EAAE,CAAC;IACjC,yCAAyC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,IAAI,GAAG,CAAC,OAAO,CAAC;CACjB,CAAC;AACF,YAAY,EAAC,OAAO,EAAE,SAAS,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC"}

package/lib/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const loader_1 = require("./loader");
+exports.default = loader_1.mdxLoader;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,qCAAmC;AAEnC,kBAAe,kBAAS,CAAC"}

package/lib/loader.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { LoaderContext } from 'webpack';
+import type { Plugin } from 'unified';
+import type { AdmonitionOptions } from './remark/admonitions';
+export declare type MDXPlugin = [
+    Plugin<any[]>,
+    any
+] | Plugin<any[]>;
+export declare type MDXOptions = {
+    admonitions: boolean | AdmonitionOptions;
+    remarkPlugins: MDXPlugin[];
+    rehypePlugins: MDXPlugin[];
+    beforeDefaultRemarkPlugins: MDXPlugin[];
+    beforeDefaultRehypePlugins: MDXPlugin[];
+};
+export declare type Options = Partial<MDXOptions> & {
+    staticDirs: string[];
+    siteDir: string;
+    isMDXPartial?: (filePath: string) => boolean;
+    isMDXPartialFrontMatterWarningDisabled?: boolean;
+    removeContentTitle?: boolean;
+    metadataPath?: string | ((filePath: string) => string);
+    createAssets?: (metadata: {
+        frontMatter: {
+            [key: string]: unknown;
+        };
+        metadata: {
+            [key: string]: unknown;
+        };
+    }) => {
+        [key: string]: unknown;
+    };
+    filepath: string;
+};
+export declare function mdxLoader(this: LoaderContext<Options>, fileString: string): Promise<void>;
+//# sourceMappingURL=loader.d.ts.map

package/lib/loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.d.ts","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAqBH,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAC;AAC3C,OAAO,KAAK,EAAY,MAAM,EAAC,MAAM,SAAS,CAAC;AAC/C,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAsB5D,oBAAY,SAAS,GAEnB;IAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IAAE,GAAG;CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;AAEvC,oBAAY,UAAU,GAAG;IACvB,WAAW,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACzC,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,aAAa,EAAE,SAAS,EAAE,CAAC;IAC3B,0BAA0B,EAAE,SAAS,EAAE,CAAC;IACxC,0BAA0B,EAAE,SAAS,EAAE,CAAC;CACzC,CAAC;AAEF,oBAAY,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG;IAC1C,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IAC7C,sCAAsC,CAAC,EAAE,OAAO,CAAC;IACjD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC,CAAC;IACvD,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE;QACxB,WAAW,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;QACtC,QAAQ,EAAE;YAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAC,CAAC;KACpC,KAAK;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AA8EF,wBAAsB,SAAS,CAC7B,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,EAC5B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CA8Hf"}

package/lib/loader.js

@@ -0,0 +1,210 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mdxLoader = void 0;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("@docusaurus/utils");
+const mdx_1 = require("@mdx-js/mdx");
+const remark_emoji_1 = tslib_1.__importDefault(require("remark-emoji"));
+const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
+const headings_1 = tslib_1.__importDefault(require("./remark/headings"));
+const toc_1 = tslib_1.__importDefault(require("./remark/toc"));
+const unwrapMdxCodeBlocks_1 = tslib_1.__importDefault(require("./remark/unwrapMdxCodeBlocks"));
+const transformImage_1 = tslib_1.__importDefault(require("./remark/transformImage"));
+const transformLinks_1 = tslib_1.__importDefault(require("./remark/transformLinks"));
+const admonitions_1 = tslib_1.__importDefault(require("./remark/admonitions"));
+const { loaders: { inlineMarkdownImageFileLoader }, } = (0, utils_1.getFileLoaderUtils)();
+const pragma = `
+/* @jsxRuntime classic */
+/* @jsx mdx */
+/* @jsxFrag React.Fragment */
+`;
+const DEFAULT_OPTIONS = {
+    admonitions: true,
+    rehypePlugins: [],
+    remarkPlugins: [unwrapMdxCodeBlocks_1.default, remark_emoji_1.default, headings_1.default, toc_1.default],
+    beforeDefaultRemarkPlugins: [],
+    beforeDefaultRehypePlugins: [],
+};
+const compilerCache = new Map();
+/**
+ * When this throws, it generally means that there's no metadata file associated
+ * with this MDX document. It can happen when using MDX partials (usually
+ * starting with _). That's why it's important to provide the `isMDXPartial`
+ * function in config
+ */
+async function readMetadataPath(metadataPath) {
+    try {
+        return await fs_extra_1.default.readFile(metadataPath, 'utf8');
+    }
+    catch (err) {
+        logger_1.default.error `MDX loader can't read MDX metadata file path=${metadataPath}. Maybe the isMDXPartial option function was not provided?`;
+        throw err;
+    }
+}
+/**
+ * Converts assets an object with Webpack require calls code.
+ * This is useful for mdx files to reference co-located assets using relative
+ * paths. Those assets should enter the Webpack assets pipeline and be hashed.
+ * For now, we only handle that for images and paths starting with `./`:
+ *
+ * `{image: "./myImage.png"}` => `{image: require("./myImage.png")}`
+ */
+function createAssetsExportCode(assets) {
+    if (typeof assets !== 'object' ||
+        !assets ||
+        Object.keys(assets).length === 0) {
+        return 'undefined';
+    }
+    // TODO implementation can be completed/enhanced
+    function createAssetValueCode(assetValue) {
+        if (Array.isArray(assetValue)) {
+            const arrayItemCodes = assetValue.map((item) => createAssetValueCode(item) ?? 'undefined');
+            return `[${arrayItemCodes.join(', ')}]`;
+        }
+        // Only process string values starting with ./
+        // We could enhance this logic and check if file exists on disc?
+        if (typeof assetValue === 'string' && assetValue.startsWith('./')) {
+            // TODO do we have other use-cases than image assets?
+            // Probably not worth adding more support, as we want to move to Webpack 5 new asset system (https://github.com/facebook/docusaurus/pull/4708)
+            const inlineLoader = inlineMarkdownImageFileLoader;
+            return `require("${inlineLoader}${(0, utils_1.escapePath)(assetValue)}").default`;
+        }
+        return undefined;
+    }
+    const assetEntries = Object.entries(assets);
+    const codeLines = assetEntries
+        .map(([key, value]) => {
+        const assetRequireCode = createAssetValueCode(value);
+        return assetRequireCode ? `"${key}": ${assetRequireCode},` : undefined;
+    })
+        .filter(Boolean);
+    return `{\n${codeLines.join('\n')}\n}`;
+}
+function getAdmonitionsPlugins(admonitionsOption) {
+    if (admonitionsOption) {
+        const plugin = admonitionsOption === true
+            ? admonitions_1.default
+            : [admonitions_1.default, admonitionsOption];
+        return [plugin];
+    }
+    return [];
+}
+async function mdxLoader(fileString) {
+    const callback = this.async();
+    const filePath = this.resourcePath;
+    const reqOptions = this.getOptions();
+    const { frontMatter, content: contentWithTitle } = (0, utils_1.parseFrontMatter)(fileString);
+    const { content, contentTitle } = (0, utils_1.parseMarkdownContentTitle)(contentWithTitle, {
+        removeContentTitle: reqOptions.removeContentTitle,
+    });
+    const hasFrontMatter = Object.keys(frontMatter).length > 0;
+    if (!compilerCache.has(this.query)) {
+        const remarkPlugins = [
+            ...(reqOptions.beforeDefaultRemarkPlugins ?? []),
+            ...getAdmonitionsPlugins(reqOptions.admonitions ?? false),
+            ...DEFAULT_OPTIONS.remarkPlugins,
+            [
+                transformImage_1.default,
+                {
+                    staticDirs: reqOptions.staticDirs,
+                    siteDir: reqOptions.siteDir,
+                },
+            ],
+            [
+                transformLinks_1.default,
+                {
+                    staticDirs: reqOptions.staticDirs,
+                    siteDir: reqOptions.siteDir,
+                },
+            ],
+            ...(reqOptions.remarkPlugins ?? []),
+        ];
+        const rehypePlugins = [
+            ...(reqOptions.beforeDefaultRehypePlugins ?? []),
+            ...DEFAULT_OPTIONS.rehypePlugins,
+            ...(reqOptions.rehypePlugins ?? []),
+        ];
+        const options = {
+            ...reqOptions,
+            remarkPlugins,
+            rehypePlugins,
+        };
+        compilerCache.set(this.query, [(0, mdx_1.createCompiler)(options), options]);
+    }
+    const [compiler, options] = compilerCache.get(this.query);
+    let result;
+    try {
+        result = await compiler
+            .process({
+            contents: content,
+            path: this.resourcePath,
+        })
+            .then((res) => res.toString());
+    }
+    catch (err) {
+        return callback(err);
+    }
+    // MDX partials are MDX files starting with _ or in a folder starting with _
+    // Partial are not expected to have associated metadata files or front matter
+    const isMDXPartial = options.isMDXPartial?.(filePath);
+    if (isMDXPartial && hasFrontMatter) {
+        const errorMessage = `Docusaurus MDX partial files should not contain front matter.
+Those partial files use the _ prefix as a convention by default, but this is configurable.
+File at ${filePath} contains front matter that will be ignored:
+${JSON.stringify(frontMatter, null, 2)}`;
+        if (!options.isMDXPartialFrontMatterWarningDisabled) {
+            const shouldError = process.env.NODE_ENV === 'test' || process.env.CI;
+            if (shouldError) {
+                return callback(new Error(errorMessage));
+            }
+            logger_1.default.warn(errorMessage);
+        }
+    }
+    function getMetadataPath() {
+        if (!isMDXPartial) {
+            // Read metadata for this MDX and export it.
+            if (options.metadataPath && typeof options.metadataPath === 'function') {
+                return options.metadataPath(filePath);
+            }
+        }
+        return undefined;
+    }
+    const metadataPath = getMetadataPath();
+    if (metadataPath) {
+        this.addDependency(metadataPath);
+    }
+    const metadataJsonString = metadataPath
+        ? await readMetadataPath(metadataPath)
+        : undefined;
+    const metadata = metadataJsonString
+        ? JSON.parse(metadataJsonString)
+        : undefined;
+    const assets = reqOptions.createAssets && metadata
+        ? reqOptions.createAssets({ frontMatter, metadata })
+        : undefined;
+    const exportsCode = `
+export const frontMatter = ${(0, stringify_object_1.default)(frontMatter)};
+export const contentTitle = ${(0, stringify_object_1.default)(contentTitle)};
+${metadataJsonString ? `export const metadata = ${metadataJsonString};` : ''}
+${assets ? `export const assets = ${createAssetsExportCode(assets)};` : ''}
+`;
+    const code = `
+${pragma}
+import React from 'react';
+import { mdx } from '@mdx-js/react';
+
+${exportsCode}
+${result}
+`;
+    return callback(null, code);
+}
+exports.mdxLoader = mdxLoader;
+//# sourceMappingURL=loader.js.map

package/lib/loader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loader.js","sourceRoot":"","sources":["../src/loader.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,gEAA0B;AAC1B,wEAAwC;AACxC,6CAK2B;AAC3B,qCAA2C;AAC3C,wEAAiC;AACjC,gFAA+C;AAE/C,yEAAyC;AACzC,+DAA+B;AAC/B,+FAA+D;AAC/D,qFAAqD;AACrD,qFAAqD;AAErD,+EAAwD;AAKxD,MAAM,EACJ,OAAO,EAAE,EAAC,6BAA6B,EAAC,GACzC,GAAG,IAAA,0BAAkB,GAAE,CAAC;AAEzB,MAAM,MAAM,GAAG;;;;CAId,CAAC;AAEF,MAAM,eAAe,GAAe;IAClC,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,EAAE;IACjB,aAAa,EAAE,CAAC,6BAAmB,EAAE,sBAAK,EAAE,kBAAQ,EAAE,aAAG,CAAC;IAC1D,0BAA0B,EAAE,EAAE;IAC9B,0BAA0B,EAAE,EAAE;CAC/B,CAAC;AAEF,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0C,CAAC;AA4BxE;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,YAAoB;IAClD,IAAI;QACF,OAAO,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;KAChD;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAM,CAAC,KAAK,CAAA,gDAAgD,YAAY,4DAA4D,CAAC;QACrI,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAAC,MAAe;IAC7C,IACE,OAAO,MAAM,KAAK,QAAQ;QAC1B,CAAC,MAAM;QACP,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAChC;QACA,OAAO,WAAW,CAAC;KACpB;IAED,gDAAgD;IAChD,SAAS,oBAAoB,CAAC,UAAmB;QAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC7B,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CACnC,CAAC,IAAa,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,WAAW,CAC7D,CAAC;YACF,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;SACzC;QACD,8CAA8C;QAC9C,gEAAgE;QAChE,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YACjE,qDAAqD;YACrD,8IAA8I;YAC9I,MAAM,YAAY,GAAG,6BAA6B,CAAC;YACnD,OAAO,YAAY,YAAY,GAAG,IAAA,kBAAU,EAAC,UAAU,CAAC,YAAY,CAAC;SACtE;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C,MAAM,SAAS,GAAG,YAAY;SAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAoB,EAAE,EAAE;QACvC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACrD,OAAO,gBAAgB,CAAC,CAAC,CAAC,IAAI,GAAG,MAAM,gBAAgB,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACzE,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAC,CAAC;IAEnB,OAAO,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;AACzC,CAAC;AAED,SAAS,qBAAqB,CAC5B,iBAA4C;IAE5C,IAAI,iBAAiB,EAAE;QACrB,MAAM,MAAM,GACV,iBAAiB,KAAK,IAAI;YACxB,CAAC,CAAC,qBAAoB;YACtB,CAAC,CAAC,CAAC,qBAAoB,EAAE,iBAAiB,CAAC,CAAC;QAChD,OAAO,CAAC,MAAM,CAAC,CAAC;KACjB;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAEM,KAAK,UAAU,SAAS,CAE7B,UAAkB;IAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,YAAY,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IAErC,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,gBAAgB,EAAC,GAAG,IAAA,wBAAgB,EAAC,UAAU,CAAC,CAAC;IAE9E,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,IAAA,iCAAyB,EAAC,gBAAgB,EAAE;QAC1E,kBAAkB,EAAE,UAAU,CAAC,kBAAkB;KAClD,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAE3D,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QAClC,MAAM,aAAa,GAAgB;YACjC,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;YAChD,GAAG,qBAAqB,CAAC,UAAU,CAAC,WAAW,IAAI,KAAK,CAAC;YACzD,GAAG,eAAe,CAAC,aAAa;YAChC;gBACE,wBAAc;gBACd;oBACE,UAAU,EAAE,UAAU,CAAC,UAAU;oBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B;aACF;YACD;gBACE,wBAAc;gBACd;oBACE,UAAU,EAAE,UAAU,CAAC,UAAU;oBACjC,OAAO,EAAE,UAAU,CAAC,OAAO;iBAC5B;aACF;YACD,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;SACpC,CAAC;QAEF,MAAM,aAAa,GAAgB;YACjC,GAAG,CAAC,UAAU,CAAC,0BAA0B,IAAI,EAAE,CAAC;YAChD,GAAG,eAAe,CAAC,aAAa;YAChC,GAAG,CAAC,UAAU,CAAC,aAAa,IAAI,EAAE,CAAC;SACpC,CAAC;QAEF,MAAM,OAAO,GAAY;YACvB,GAAG,UAAU;YACb,aAAa;YACb,aAAa;SACd,CAAC;QACF,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,IAAA,oBAAc,EAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;KACnE;IAED,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAE,CAAC;IAE3D,IAAI,MAAc,CAAC;IACnB,IAAI;QACF,MAAM,GAAG,MAAM,QAAQ;aACpB,OAAO,CAAC;YACP,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,IAAI,CAAC,YAAY;SACxB,CAAC;aACD,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;KAClC;IAAC,OAAO,GAAG,EAAE;QACZ,OAAO,QAAQ,CAAC,GAAY,CAAC,CAAC;KAC/B;IAED,4EAA4E;IAC5E,6EAA6E;IAC7E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,YAAY,IAAI,cAAc,EAAE;QAClC,MAAM,YAAY,GAAG;;UAEf,QAAQ;EAChB,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;QAErC,IAAI,CAAC,OAAO,CAAC,sCAAsC,EAAE;YACnD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACtE,IAAI,WAAW,EAAE;gBACf,OAAO,QAAQ,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;aAC1C;YACD,gBAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC3B;KACF;IAED,SAAS,eAAe;QACtB,IAAI,CAAC,YAAY,EAAE;YACjB,4CAA4C;YAC5C,IAAI,OAAO,CAAC,YAAY,IAAI,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU,EAAE;gBACtE,OAAO,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvC;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,IAAI,YAAY,EAAE;QAChB,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;KAClC;IAED,MAAM,kBAAkB,GAAG,YAAY;QACrC,CAAC,CAAC,MAAM,gBAAgB,CAAC,YAAY,CAAC;QACtC,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,QAAQ,GAAG,kBAAkB;QACjC,CAAC,CAAE,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAA8B;QAC9D,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,MAAM,GACV,UAAU,CAAC,YAAY,IAAI,QAAQ;QACjC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,WAAW,GAAG;6BACO,IAAA,0BAAe,EAAC,WAAW,CAAC;8BAC3B,IAAA,0BAAe,EAAC,YAAY,CAAC;EACzD,kBAAkB,CAAC,CAAC,CAAC,2BAA2B,kBAAkB,GAAG,CAAC,CAAC,CAAC,EAAE;EAC1E,MAAM,CAAC,CAAC,CAAC,yBAAyB,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;CACzE,CAAC;IAEA,MAAM,IAAI,GAAG;EACb,MAAM;;;;EAIN,WAAW;EACX,MAAM;CACP,CAAC;IAEA,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9B,CAAC;AAjID,8BAiIC"}

package/lib/remark/admonitions/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Plugin } from 'unified';
+export declare type AdmonitionOptions = {
+    tag: string;
+    keywords: string[];
+};
+export declare const DefaultAdmonitionOptions: AdmonitionOptions;
+declare const plugin: Plugin;
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/lib/remark/admonitions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/admonitions/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAyB,MAAM,EAAC,MAAM,SAAS,CAAC;AAK5D,oBAAY,iBAAiB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,iBAatC,CAAC;AAgBF,QAAA,MAAM,MAAM,EAAE,MAwIb,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/lib/remark/admonitions/index.js

@@ -0,0 +1,132 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultAdmonitionOptions = void 0;
+const tslib_1 = require("tslib");
+const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
+const NEWLINE = '\n';
+exports.DefaultAdmonitionOptions = {
+    tag: ':::',
+    keywords: [
+        'secondary',
+        'info',
+        'success',
+        'danger',
+        'note',
+        'tip',
+        'warning',
+        'important',
+        'caution',
+    ],
+};
+function escapeRegExp(s) {
+    return s.replace(/[-[\]{}()*+?.\\^$|/]/g, '\\$&');
+}
+function normalizeOptions(options) {
+    return { ...exports.DefaultAdmonitionOptions, ...options };
+}
+// This string value does not matter much
+// It is ignored because nodes are using hName/hProperties coming from HAST
+const admonitionNodeType = 'admonitionHTML';
+const plugin = function plugin(optionsInput = {}) {
+    const options = normalizeOptions(optionsInput);
+    const keywords = Object.values(options.keywords).map(escapeRegExp).join('|');
+    const tag = escapeRegExp(options.tag);
+    const regex = new RegExp(`${tag}(${keywords})(?: *(.*))?\n`);
+    const escapeTag = new RegExp(escapeRegExp(`\\${options.tag}`), 'g');
+    // The tokenizer is called on blocks to determine if there is an admonition
+    // present and create tags for it
+    function blockTokenizer(eat, value, silent) {
+        // Stop if no match or match does not start at beginning of line
+        const match = regex.exec(value);
+        if (!match || match.index !== 0) {
+            return false;
+        }
+        // If silent return the match
+        if (silent) {
+            return true;
+        }
+        const now = eat.now();
+        const [opening, keyword, title] = match;
+        const food = [];
+        const content = [];
+        let newValue = value;
+        // consume lines until a closing tag
+        let idx = newValue.indexOf(NEWLINE);
+        while (idx !== -1) {
+            // grab this line and eat it
+            const next = newValue.indexOf(NEWLINE, idx + 1);
+            const line = next !== -1 ? newValue.slice(idx + 1, next) : newValue.slice(idx + 1);
+            food.push(line);
+            newValue = newValue.slice(idx + 1);
+            // the closing tag is NOT part of the content
+            if (line.startsWith(options.tag)) {
+                break;
+            }
+            content.push(line);
+            idx = newValue.indexOf(NEWLINE);
+        }
+        // consume the processed tag and replace escape sequences
+        const contentString = content.join(NEWLINE).replace(escapeTag, options.tag);
+        const add = eat(opening + food.join(NEWLINE));
+        // parse the content in block mode
+        const exit = this.enterBlock();
+        const contentNodes = this.tokenizeBlock(contentString, now);
+        exit();
+        const titleNodes = this.tokenizeInline(title, now);
+        const isSimpleTextTitle = titleNodes.length === 1 && titleNodes[0].type === 'text';
+        const element = {
+            type: admonitionNodeType,
+            data: {
+                // hName/hProperties come from HAST
+                // See https://github.com/syntax-tree/mdast-util-to-hast#fields-on-nodes
+                hName: 'admonition',
+                hProperties: {
+                    ...(title && isSimpleTextTitle && { title }),
+                    type: keyword,
+                },
+            },
+            children: [
+                // For titles containing MDX syntax: create a custom element. The theme
+                // component will extract it and render it nicely.
+                //
+                // Temporary workaround, because it's complex in MDX v1 to emit
+                // interpolated JSX prop syntax (title={<>my <code>title</code></>}).
+                // For this reason, we use children instead of the title prop.
+                title &&
+                    !isSimpleTextTitle && {
+                    type: admonitionNodeType,
+                    data: {
+                        hName: 'mdxAdmonitionTitle',
+                        hProperties: {},
+                    },
+                    children: titleNodes,
+                },
+                ...contentNodes,
+            ].filter(Boolean),
+        };
+        return add(element);
+    }
+    // add tokenizer to parser after fenced code blocks
+    const Parser = this.Parser.prototype;
+    Parser.blockTokenizers.admonition = blockTokenizer;
+    Parser.blockMethods.splice(Parser.blockMethods.indexOf('fencedCode') + 1, 0, 'admonition');
+    Parser.interruptParagraph.splice(Parser.interruptParagraph.indexOf('fencedCode') + 1, 0, ['admonition']);
+    Parser.interruptList.splice(Parser.interruptList.indexOf('fencedCode') + 1, 0, ['admonition']);
+    Parser.interruptBlockquote.splice(Parser.interruptBlockquote.indexOf('fencedCode') + 1, 0, ['admonition']);
+    return (root) => {
+        // escape everything except admonitionHTML nodes
+        (0, unist_util_visit_1.default)(root, (node) => node?.type !== admonitionNodeType, (node) => {
+            if (node.value) {
+                node.value = node.value.replace(escapeTag, options.tag);
+            }
+        });
+    };
+};
+exports.default = plugin;
+//# sourceMappingURL=index.js.map

package/lib/remark/admonitions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/admonitions/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,gFAAqC;AAIrC,MAAM,OAAO,GAAG,IAAI,CAAC;AAOR,QAAA,wBAAwB,GAAsB;IACzD,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE;QACR,WAAW;QACX,MAAM;QACN,SAAS;QACT,QAAQ;QACR,MAAM;QACN,KAAK;QACL,SAAS;QACT,WAAW;QACX,SAAS;KACV;CACF,CAAC;AAEF,SAAS,YAAY,CAAC,CAAS;IAC7B,OAAO,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAmC;IAEnC,OAAO,EAAC,GAAG,gCAAwB,EAAE,GAAG,OAAO,EAAC,CAAC;AACnD,CAAC;AAED,yCAAyC;AACzC,2EAA2E;AAC3E,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAE5C,MAAM,MAAM,GAAW,SAAS,MAAM,CAEpC,eAA2C,EAAE;IAE7C,MAAM,OAAO,GAAG,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAE/C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7E,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,GAAG,GAAG,IAAI,QAAQ,gBAAgB,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;IAEpE,2EAA2E;IAC3E,iCAAiC;IACjC,SAAS,cAAc,CAAY,GAAQ,EAAE,KAAa,EAAE,MAAe;QACzE,gEAAgE;QAChE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,EAAE;YAC/B,OAAO,KAAK,CAAC;SACd;QACD,6BAA6B;QAC7B,IAAI,MAAM,EAAE;YACV,OAAO,IAAI,CAAC;SACb;QAED,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;QACtB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,GAAG,KAIjC,CAAC;QACF,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,oCAAoC;QACpC,IAAI,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,OAAO,GAAG,KAAK,CAAC,CAAC,EAAE;YACjB,4BAA4B;YAC5B,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;YAChD,MAAM,IAAI,GACR,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YACxE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChB,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;YACnC,6CAA6C;YAC7C,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAChC,MAAM;aACP;YACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACjC;QAED,yDAAyD;QACzD,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5E,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAE9C,kCAAkC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAC/B,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QAC5D,IAAI,EAAE,CAAC;QAEP,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEnD,MAAM,iBAAiB,GACrB,UAAU,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC;QAE3D,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,kBAAkB;YACxB,IAAI,EAAE;gBACJ,mCAAmC;gBACnC,wEAAwE;gBACxE,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE;oBACX,GAAG,CAAC,KAAK,IAAI,iBAAiB,IAAI,EAAC,KAAK,EAAC,CAAC;oBAC1C,IAAI,EAAE,OAAO;iBACd;aACF;YACD,QAAQ,EAAE;gBACR,uEAAuE;gBACvE,kDAAkD;gBAClD,EAAE;gBACF,+DAA+D;gBAC/D,qEAAqE;gBACrE,8DAA8D;gBAC9D,KAAK;oBACH,CAAC,iBAAiB,IAAI;oBACpB,IAAI,EAAE,kBAAkB;oBACxB,IAAI,EAAE;wBACJ,KAAK,EAAE,oBAAoB;wBAC3B,WAAW,EAAE,EAAE;qBAChB;oBACD,QAAQ,EAAE,UAAU;iBACrB;gBACH,GAAG,YAAY;aAChB,CAAC,MAAM,CAAC,OAAO,CAAC;SAClB,CAAC;QAEF,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAED,mDAAmD;IACnD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IACrC,MAAM,CAAC,eAAe,CAAC,UAAU,GAAG,cAAc,CAAC;IACnD,MAAM,CAAC,YAAY,CAAC,MAAM,CACxB,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EAC7C,CAAC,EACD,YAAY,CACb,CAAC;IACF,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAC9B,MAAM,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EACnD,CAAC,EACD,CAAC,YAAY,CAAC,CACf,CAAC;IACF,MAAM,CAAC,aAAa,CAAC,MAAM,CACzB,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EAC9C,CAAC,EACD,CAAC,YAAY,CAAC,CACf,CAAC;IACF,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAC/B,MAAM,CAAC,mBAAmB,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,EACpD,CAAC,EACD,CAAC,YAAY,CAAC,CACf,CAAC;IAEF,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,gDAAgD;QAChD,IAAA,0BAAK,EACH,IAAI,EACJ,CAAC,IAAa,EAAmB,EAAE,CAChC,IAA4B,EAAE,IAAI,KAAK,kBAAkB,EAC5D,CAAC,IAAa,EAAE,EAAE;YAChB,IAAI,IAAI,CAAC,KAAK,EAAE;gBACd,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;aACzD;QACH,CAAC,CACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/lib/remark/headings/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Transformer } from 'unified';
+export default function plugin(): Transformer;
+//# sourceMappingURL=index.d.ts.map

package/lib/remark/headings/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/headings/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAGzC,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,WAAW,CAsD5C"}

package/lib/remark/headings/index.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/* Based on remark-slug (https://github.com/remarkjs/remark-slug) and gatsby-remark-autolink-headers (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-remark-autolink-headers) */
+const utils_1 = require("@docusaurus/utils");
+const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
+const mdast_util_to_string_1 = tslib_1.__importDefault(require("mdast-util-to-string"));
+function plugin() {
+    return (root) => {
+        const slugs = (0, utils_1.createSlugger)();
+        (0, unist_util_visit_1.default)(root, 'heading', (headingNode) => {
+            const data = headingNode.data ?? (headingNode.data = {});
+            const properties = (data.hProperties || (data.hProperties = {}));
+            let { id } = properties;
+            if (id) {
+                id = slugs.slug(id, { maintainCase: true });
+            }
+            else {
+                const headingTextNodes = headingNode.children.filter(({ type }) => !['html', 'jsx'].includes(type));
+                const heading = (0, mdast_util_to_string_1.default)(headingTextNodes.length > 0 ? headingTextNodes : headingNode);
+                // Support explicit heading IDs
+                const parsedHeading = (0, utils_1.parseMarkdownHeadingId)(heading);
+                id = parsedHeading.id ?? slugs.slug(heading);
+                if (parsedHeading.id) {
+                    // When there's an id, it is always in the last child node
+                    // Sometimes heading is in multiple "parts" (** syntax creates a child
+                    // node):
+                    // ## part1 *part2* part3 {#id}
+                    const lastNode = headingNode.children[headingNode.children.length - 1];
+                    if (headingNode.children.length > 1) {
+                        const lastNodeText = (0, utils_1.parseMarkdownHeadingId)(lastNode.value).text;
+                        // When last part contains test+id, remove the id
+                        if (lastNodeText) {
+                            lastNode.value = lastNodeText;
+                        }
+                        // When last part contains only the id: completely remove that node
+                        else {
+                            headingNode.children.pop();
+                        }
+                    }
+                    else {
+                        lastNode.value = parsedHeading.text;
+                    }
+                }
+            }
+            data.id = id;
+            properties.id = id;
+        });
+    };
+}
+exports.default = plugin;
+//# sourceMappingURL=index.js.map

package/lib/remark/headings/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/remark/headings/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,gMAAgM;AAEhM,6CAAwE;AACxE,gFAAqC;AACrC,wFAAiD;AAIjD,SAAwB,MAAM;IAC5B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,MAAM,KAAK,GAAG,IAAA,qBAAa,GAAE,CAAC;QAC9B,IAAA,0BAAK,EAAC,IAAI,EAAE,SAAS,EAAE,CAAC,WAAoB,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;YACzD,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC,CAE9D,CAAC;YACF,IAAI,EAAC,EAAE,EAAC,GAAG,UAAU,CAAC;YAEtB,IAAI,EAAE,EAAE;gBACN,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAC,YAAY,EAAE,IAAI,EAAC,CAAC,CAAC;aAC3C;iBAAM;gBACL,MAAM,gBAAgB,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAClD,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAC5C,CAAC;gBACF,MAAM,OAAO,GAAG,IAAA,8BAAa,EAC3B,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW,CAC7D,CAAC;gBAEF,+BAA+B;gBAC/B,MAAM,aAAa,GAAG,IAAA,8BAAsB,EAAC,OAAO,CAAC,CAAC;gBAEtD,EAAE,GAAG,aAAa,CAAC,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAE7C,IAAI,aAAa,CAAC,EAAE,EAAE;oBACpB,0DAA0D;oBAC1D,sEAAsE;oBACtE,SAAS;oBACT,+BAA+B;oBAC/B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CACnC,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CACxB,CAAC;oBAEV,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;wBACnC,MAAM,YAAY,GAAG,IAAA,8BAAsB,EAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;wBACjE,iDAAiD;wBACjD,IAAI,YAAY,EAAE;4BAChB,QAAQ,CAAC,KAAK,GAAG,YAAY,CAAC;yBAC/B;wBACD,mEAAmE;6BAC9D;4BACH,WAAW,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;yBAC5B;qBACF;yBAAM;wBACL,QAAQ,CAAC,KAAK,GAAG,aAAa,CAAC,IAAI,CAAC;qBACrC;iBACF;aACF;YAED,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;YACb,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAtDD,yBAsDC"}

package/lib/remark/toc/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Transformer } from 'unified';
+export default function plugin(): Transformer;
+//# sourceMappingURL=index.d.ts.map

package/lib/remark/toc/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/remark/toc/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAoDzC,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,WAAW,CA2B5C"}

package/lib/remark/toc/index.js

@@ -0,0 +1,81 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const parser_1 = require("@babel/parser");
+const traverse_1 = tslib_1.__importDefault(require("@babel/traverse"));
+const stringify_object_1 = tslib_1.__importDefault(require("stringify-object"));
+const mdast_util_to_string_1 = tslib_1.__importDefault(require("mdast-util-to-string"));
+const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
+const utils_1 = require("../utils");
+const parseOptions = {
+    plugins: ['jsx'],
+    sourceType: 'module',
+};
+const name = 'toc';
+const isImport = (child) => child.type === 'import';
+const hasImports = (index) => index > -1;
+const isExport = (child) => child.type === 'export';
+const isTarget = (child) => {
+    let found = false;
+    const ast = (0, parser_1.parse)(child.value, parseOptions);
+    (0, traverse_1.default)(ast, {
+        VariableDeclarator: (path) => {
+            if (path.node.id.name === name) {
+                found = true;
+            }
+        },
+    });
+    return found;
+};
+const getOrCreateExistingTargetIndex = (children) => {
+    let importsIndex = -1;
+    let targetIndex = -1;
+    children.forEach((child, index) => {
+        if (isImport(child)) {
+            importsIndex = index;
+        }
+        else if (isExport(child) && isTarget(child)) {
+            targetIndex = index;
+        }
+    });
+    if (targetIndex === -1) {
+        const target = {
+            default: false,
+            type: 'export',
+            value: `export const ${name} = [];`,
+        };
+        targetIndex = hasImports(importsIndex) ? importsIndex + 1 : 0;
+        children.splice(targetIndex, 0, target);
+    }
+    return targetIndex;
+};
+function plugin() {
+    return (root) => {
+        const headings = [];
+        (0, unist_util_visit_1.default)(root, 'heading', (child, index, parent) => {
+            const value = (0, mdast_util_to_string_1.default)(child);
+            // depth: 1 headings are titles and not included in the TOC
+            if (parent !== root || !value || child.depth < 2) {
+                return;
+            }
+            headings.push({
+                value: (0, utils_1.toValue)(child),
+                id: child.data.id,
+                level: child.depth,
+            });
+        });
+        const { children } = root;
+        const targetIndex = getOrCreateExistingTargetIndex(children);
+        if (headings.length) {
+            children[targetIndex].value = `export const ${name} = ${(0, stringify_object_1.default)(headings)};`;
+        }
+    };
+}
+exports.default = plugin;
+//# sourceMappingURL=index.js.map