fumadocs-core 8.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Fuma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,5 @@
+# Fumadocs Core
+
+The core library for Fumadocs.
+
+📘 Learn More: [Documentation](https://fumadocs.vercel.app)

package/dist/breadcrumb.d.ts

@@ -0,0 +1,11 @@
+import { R as Root } from './page-tree-izSPERQk.js';
+import 'react';
+
+interface BreadcrumbItem {
+    name: string;
+    url: string | null;
+}
+declare function useBreadcrumb(url: string, tree: Root): BreadcrumbItem[];
+declare function getBreadcrumbItems(url: string, tree: Root): BreadcrumbItem[];
+
+export { type BreadcrumbItem, getBreadcrumbItems, useBreadcrumb };

package/dist/breadcrumb.js

@@ -0,0 +1,47 @@
+import "./chunk-WEAGW6MQ.js";
+
+// src/breadcrumb.tsx
+import { useMemo } from "react";
+function useBreadcrumb(url, tree) {
+  return useMemo(() => getBreadcrumbItems(url, tree), [tree, url]);
+}
+function getBreadcrumbItems(url, tree) {
+  var _a;
+  return (_a = searchPath(tree.children, url)) != null ? _a : [];
+}
+function searchPath(nodes, url) {
+  var _a, _b;
+  for (const node of nodes) {
+    if (node.type === "folder") {
+      if (node.index && node.index.url === url) {
+        return [
+          {
+            name: node.index.name,
+            url: node.index.url
+          }
+        ];
+      }
+      const items = searchPath(node.children, url);
+      if (items !== null) {
+        items.unshift({
+          name: node.name,
+          url: (_b = (_a = node.index) == null ? void 0 : _a.url) != null ? _b : null
+        });
+        return items;
+      }
+    }
+    if (node.type === "page" && node.url === url) {
+      return [
+        {
+          name: node.name,
+          url: node.url
+        }
+      ];
+    }
+  }
+  return null;
+}
+export {
+  getBreadcrumbItems,
+  useBreadcrumb
+};

package/dist/chunk-2ZGUSAWB.js

@@ -0,0 +1,12 @@
+// src/utils/slash.ts
+function slash(path) {
+  const isExtendedLengthPath = path.startsWith("\\\\?\\");
+  if (isExtendedLengthPath) {
+    return path;
+  }
+  return path.replace("\\", "/");
+}
+
+export {
+  slash
+};

package/dist/chunk-AFKH746E.js

@@ -0,0 +1,40 @@
+import {
+  __objRest,
+  __spreadProps,
+  __spreadValues
+} from "./chunk-WEAGW6MQ.js";
+
+// src/link.tsx
+import Original from "next/link";
+import { forwardRef } from "react";
+import { jsx } from "react/jsx-runtime";
+var Link = forwardRef(
+  (_a, ref) => {
+    var _b = _a, {
+      href = "#",
+      external = !(href.startsWith("/") || href.startsWith("#") || href.startsWith("."))
+    } = _b, props = __objRest(_b, [
+      "href",
+      "external"
+    ]);
+    if (external) {
+      return /* @__PURE__ */ jsx(
+        "a",
+        __spreadProps(__spreadValues({
+          ref,
+          href,
+          rel: "noreferrer noopener",
+          target: "_blank"
+        }, props), {
+          children: props.children
+        })
+      );
+    }
+    return /* @__PURE__ */ jsx(Original, __spreadValues({ ref, href }, props));
+  }
+);
+Link.displayName = "Link";
+
+export {
+  Link
+};

package/dist/chunk-GT3Y35O6.js

@@ -0,0 +1,46 @@
+// src/mdx-plugins/remark-heading.ts
+import Slugger from "github-slugger";
+
+// src/mdx-plugins/unist-visit.ts
+import { visit as original } from "unist-util-visit";
+var visit = original;
+
+// src/mdx-plugins/remark-utils.ts
+function flattenNode(node) {
+  if ("children" in node)
+    return node.children.map((child) => flattenNode(child)).join("");
+  if ("value" in node)
+    return node.value;
+  return "";
+}
+
+// src/mdx-plugins/remark-heading.ts
+var slugger = new Slugger();
+function remarkHeading() {
+  return (node, file) => {
+    const toc = [];
+    slugger.reset();
+    visit(node, ["heading"], (heading) => {
+      var _a;
+      heading.data || (heading.data = {});
+      (_a = heading.data).hProperties || (_a.hProperties = {});
+      const text = flattenNode(heading);
+      const properties = heading.data.hProperties;
+      const id = slugger.slug(properties.id || text);
+      properties.id = id;
+      toc.push({
+        title: text,
+        url: `#${id}`,
+        depth: heading.depth
+      });
+      return "skip";
+    });
+    file.data.toc = toc;
+  };
+}
+
+export {
+  visit,
+  flattenNode,
+  remarkHeading
+};

package/dist/chunk-WEAGW6MQ.js

@@ -0,0 +1,63 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+export {
+  __spreadValues,
+  __spreadProps,
+  __objRest,
+  __export,
+  __async
+};

package/dist/dynamic-link.d.ts

@@ -0,0 +1,14 @@
+import * as react from 'react';
+import { LinkProps } from './link.js';
+
+type DynamicLinkProps = LinkProps;
+/**
+ * Extends the default `Link` component
+ *
+ * It supports dynamic hrefs, which means you can use `/[lang]/my-page` with `dynamicHrefs` enabled
+ */
+declare const DynamicLink: react.ForwardRefExoticComponent<react.AnchorHTMLAttributes<HTMLAnchorElement> & {
+    external?: boolean | undefined;
+} & react.RefAttributes<HTMLAnchorElement>>;
+
+export { DynamicLink, type DynamicLinkProps, DynamicLink as default };

package/dist/dynamic-link.js

@@ -0,0 +1,33 @@
+"use client";
+import {
+  Link
+} from "./chunk-AFKH746E.js";
+import {
+  __objRest,
+  __spreadValues
+} from "./chunk-WEAGW6MQ.js";
+
+// src/dynamic-link.tsx
+import { useParams } from "next/navigation";
+import { forwardRef, useMemo } from "react";
+import { jsx } from "react/jsx-runtime";
+var DynamicLink = forwardRef(
+  (_a, ref) => {
+    var _b = _a, { href } = _b, props = __objRest(_b, ["href"]);
+    const params = useParams();
+    const url = useMemo(() => {
+      return href == null ? void 0 : href.replace(/\[.*\]/, (key) => {
+        const mappedKey = key.slice(1, -1);
+        const value = mappedKey in params ? params[mappedKey] : "undefined";
+        return typeof value === "string" ? value : value.join("/");
+      });
+    }, [params, href]);
+    return /* @__PURE__ */ jsx(Link, __spreadValues({ ref, href: url }, props));
+  }
+);
+DynamicLink.displayName = "DynamicLink";
+var dynamic_link_default = DynamicLink;
+export {
+  DynamicLink,
+  dynamic_link_default as default
+};

package/dist/get-toc-YF_TdazL.d.ts

@@ -0,0 +1,14 @@
+interface TOCItemType {
+    title: string;
+    url: string;
+    depth: number;
+}
+type TableOfContents = TOCItemType[];
+/**
+ * Get Table of Contents from markdown/mdx document (using remark)
+ *
+ * @param content - Markdown content
+ */
+declare function getTableOfContents(content: string): Promise<TableOfContents>;
+
+export { type TableOfContents as T, type TOCItemType as a, getTableOfContents as g };

package/dist/link.d.ts

@@ -0,0 +1,24 @@
+import * as react from 'react';
+import { AnchorHTMLAttributes } from 'react';
+
+type LinkProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
+    /**
+     * If the href is an external URL
+     *
+     * automatically determined by default
+     */
+    external?: boolean;
+};
+/**
+ * Wraps `next/link` and safe to use in mdx documents
+ */
+declare const Link: react.ForwardRefExoticComponent<AnchorHTMLAttributes<HTMLAnchorElement> & {
+    /**
+     * If the href is an external URL
+     *
+     * automatically determined by default
+     */
+    external?: boolean | undefined;
+} & react.RefAttributes<HTMLAnchorElement>>;
+
+export { type LinkProps, Link as default };

package/dist/link.js

@@ -0,0 +1,7 @@
+import {
+  Link
+} from "./chunk-AFKH746E.js";
+import "./chunk-WEAGW6MQ.js";
+export {
+  Link as default
+};

package/dist/mdx-plugins/index.d.ts

@@ -0,0 +1,89 @@
+export { Options as RemarkGfmOptions, default as remarkGfm } from 'remark-gfm';
+import { Root } from 'hast';
+import { RehypeShikijiOptions } from 'rehype-shikiji';
+import { Processor, Transformer } from 'unified';
+import { Root as Root$1 } from 'mdast';
+export { S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-RwYPDA6M.js';
+
+declare const rehypeCodeDefaultOptions: RehypeCodeOptions;
+type RehypeCodeOptions = RehypeShikijiOptions & {
+    /**
+     * Filter meta string before processing
+     */
+    filterMetaString?: (metaString: string) => string;
+    /**
+     * Default language
+     *
+     * @defaultValue plaintext
+     */
+    defaultLang?: string;
+};
+/**
+ * Handle codeblocks
+ */
+declare function rehypeCode(this: Processor, options?: Partial<RehypeCodeOptions>): Transformer<Root, Root>;
+
+interface RemarkImageOptions {
+    /**
+     * Preferred placeholder type
+     *
+     * @defaultValue 'blur'
+     */
+    placeholder?: 'blur' | 'none';
+}
+/**
+ * Turn images into static imports
+ */
+declare function remarkImage({ placeholder, }?: RemarkImageOptions): Transformer<Root$1, Root$1>;
+
+interface RemarkDynamicContentOptions {
+    /** @defaultValue `process.cwd()` */
+    cwd?: string;
+    /** @defaultValue true */
+    trim?: boolean;
+    /**
+     * Filter specific element types
+     * @defaultValue `['text','code']`
+     * */
+    visit?: string[];
+}
+/**
+ * Copy content from referenced file
+ *
+ * @example
+ * |reference:../path/to/file.ts|
+ */
+declare function remarkDynamicContent(options?: RemarkDynamicContentOptions): Transformer<Root$1, Root$1>;
+
+interface HProperties {
+    id?: string;
+}
+/**
+ * Add heading ids and extract TOC
+ *
+ * Attach an array of `TOCItemType` to `vfile.data.toc`
+ */
+declare function remarkHeading(): Transformer<Root$1, Root$1>;
+
+type PackageManager = (name: string) => {
+    packageManager: string;
+    command: string;
+};
+type RemarkInstallOptions = Partial<{
+    Tabs: string;
+    Tab: string;
+    packageManagers: PackageManager[];
+}>;
+/**
+ * It generates the following structure from a code block with `package-install` as language
+ *
+ * ```tsx
+ * <Tabs items={["pnpm", "npm", "yarn"]}>
+ *  <Tab value="pnpm">...</Tab>
+ *  ...
+ * </Tabs>
+ * ```
+ */
+declare function remarkInstall({ Tab, Tabs, packageManagers, }?: RemarkInstallOptions): Transformer<Root$1, Root$1>;
+
+export { type HProperties, type RehypeCodeOptions, type RemarkDynamicContentOptions, type RemarkImageOptions, type RemarkInstallOptions, rehypeCode, rehypeCodeDefaultOptions, remarkDynamicContent, remarkHeading, remarkImage, remarkInstall };