fumadocs-core 12.5.5 → 13.0.0

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

@@ -26,13 +26,6 @@ type RehypeCodeOptions = RehypeShikiOptions & {
      * Filter meta string before processing
      */
     filterMetaString?: (metaString: string) => string;
-    /**
-     * Default language
-     *
-     * @defaultValue plaintext
-     * @deprecated Use `defaultLanguage` instead
-     */
-    defaultLang?: string;
     /**
      * Add icon to code blocks
      */
@@ -85,4 +78,19 @@ interface RemarkHeadingOptions {
  */
 declare function remarkHeading({ slug: defaultSlug, customId, }?: RemarkHeadingOptions): Transformer<Root$1, Root$1>;
 
-export { type CodeBlockIcon, type RehypeCodeOptions, type RemarkHeadingOptions, type RemarkImageOptions, rehypeCode, rehypeCodeDefaultOptions, remarkHeading, remarkImage, transformerIcon };
+interface RemarkAdmonitionOptions {
+    tag?: string;
+    types?: string[];
+    /**
+     * Map type to another type
+     */
+    typeMap?: Record<string, string>;
+}
+/**
+ * Remark Plugin to support Admonition syntax
+ *
+ * Useful when Migrating from Docusaurus
+ */
+declare function remarkAdmonition(options?: RemarkAdmonitionOptions): Transformer<Root$1, Root$1>;
+
+export { type CodeBlockIcon, type RehypeCodeOptions, type RemarkAdmonitionOptions, type RemarkHeadingOptions, type RemarkImageOptions, rehypeCode, rehypeCodeDefaultOptions, remarkAdmonition, remarkHeading, remarkImage, transformerIcon };

package/dist/mdx-plugins/index.js

@@ -241,9 +241,6 @@ function rehypeCode(options = {}) {
   if (codeOptions.tab !== false) {
     codeOptions.transformers = [...codeOptions.transformers, transformerTab()];
   }
-  if (codeOptions.defaultLang) {
-    codeOptions.defaultLanguage = codeOptions.defaultLang;
-  }
   return rehypeShiki.call(this, codeOptions);
 }
 function transformerTab() {
@@ -406,9 +403,74 @@ function structure(content, remarkPlugins = [], options = {}) {
   const result = remark().use(remarkGfm).use(remarkMdx).use(remarkPlugins).use(remarkStructure, options).processSync(content);
   return result.data.structuredData;
 }
+
+// src/mdx-plugins/remark-admonition.ts
+import { visit as visit3 } from "unist-util-visit";
+function remarkAdmonition(options = {}) {
+  const types = options.types ?? ["warn", "info", "error"];
+  const tag = options.tag ?? ":::";
+  const typeMap = options.typeMap ?? {
+    note: "info",
+    tip: "info",
+    warning: "warn",
+    danger: "error"
+  };
+  function replaceNodes(nodes) {
+    if (nodes.length === 0) return nodes;
+    let open = -1, end = -1;
+    const attributes = [];
+    for (let i = 0; i < nodes.length; i++) {
+      if (nodes[i].type !== "paragraph") continue;
+      const text = flattenNode(nodes[i]);
+      const start = types.find((type) => text.startsWith(`${tag}${type}`));
+      if (start) {
+        if (open !== -1) throw new Error("Nested callout is not supported");
+        open = i;
+        attributes.push({
+          type: "mdxJsxAttribute",
+          name: "type",
+          value: start in typeMap ? typeMap[start] : start
+        });
+        const rest = text.slice(`${tag}${start}`.length);
+        if (rest.startsWith("[") && rest.endsWith("]")) {
+          attributes.push({
+            type: "mdxJsxAttribute",
+            name: "title",
+            value: rest.slice(1, -1)
+          });
+        }
+      }
+      if (open !== -1 && text === tag) {
+        end = i;
+        break;
+      }
+    }
+    if (open === -1 || end === -1) return nodes;
+    return [
+      ...nodes.slice(0, open),
+      {
+        type: "mdxJsxFlowElement",
+        name: "Callout",
+        attributes,
+        children: nodes.slice(open + 1, end)
+      },
+      ...replaceNodes(nodes.slice(end + 1))
+    ];
+  }
+  return (tree) => {
+    visit3(tree, (node) => {
+      if (!("children" in node)) return "skip";
+      const result = replaceNodes(node.children);
+      if (result === node.children) return;
+      node.children = result;
+      return "skip";
+    });
+  };
+}
 export {
   rehypeCode,
   rehypeCodeDefaultOptions,
+  remarkAdmonition,
   default2 as remarkGfm,
   remarkHeading,
   remarkImage,

package/dist/toc.d.ts

@@ -1,28 +1,28 @@
 import * as react from 'react';
-import { HTMLAttributes, RefObject, ReactNode, AnchorHTMLAttributes } from 'react';
+import { ReactNode, RefObject, AnchorHTMLAttributes } from 'react';
 import { T as TableOfContents } from './get-toc-CM4X3hbw.js';
 
-declare const useActiveAnchor: (url: string) => boolean;
-interface TOCProviderProps extends HTMLAttributes<HTMLDivElement> {
+/**
+ * The id of active anchor (doesn't include hash)
+ */
+declare function useActiveAnchor(): string | undefined;
+interface AnchorProviderProps {
     toc: TableOfContents;
+    children?: ReactNode;
 }
-declare const TOCProvider: react.ForwardRefExoticComponent<TOCProviderProps & react.RefAttributes<HTMLDivElement>>;
-interface TOCScrollProvider {
+interface ScrollProviderProps {
     /**
      * Scroll into the view of container when active
      */
-    containerRef?: RefObject<HTMLElement>;
-    toc: TableOfContents;
-    children: ReactNode;
+    containerRef: RefObject<HTMLElement>;
+    children?: ReactNode;
 }
-declare function TOCScrollProvider({ toc, containerRef, children, }: TOCScrollProvider): React.ReactElement;
-interface TOCItemProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
+declare function ScrollProvider({ containerRef, children, }: ScrollProviderProps): React.ReactElement;
+declare function AnchorProvider({ toc, children, }: AnchorProviderProps): React.ReactElement;
+interface TOCItemProps extends Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
     href: string;
-    /**
-     * Scroll into the view of container when active
-     */
-    containerRef?: RefObject<HTMLElement>;
+    onActiveChange?: (v: boolean) => void;
 }
 declare const TOCItem: react.ForwardRefExoticComponent<TOCItemProps & react.RefAttributes<HTMLAnchorElement>>;
 
-export { TOCItem, type TOCItemProps, TOCProvider, type TOCProviderProps, TOCScrollProvider, useActiveAnchor };
+export { AnchorProvider, type AnchorProviderProps, ScrollProvider, type ScrollProviderProps, TOCItem, type TOCItemProps, useActiveAnchor };

package/dist/toc.js

@@ -1,53 +1,92 @@
 import {
-  mergeRefs,
-  useAnchorObserver
-} from "./chunk-V6DBK6TW.js";
+  useOnChange
+} from "./chunk-KGMG4N3Y.js";
 import "./chunk-MLKGABMK.js";
 
 // src/toc.tsx
-import {
-  createContext,
-  forwardRef,
-  useContext,
-  useEffect,
-  useMemo,
-  useRef
-} from "react";
+import { createContext, forwardRef, useContext, useMemo, useRef } from "react";
 import scrollIntoView from "scroll-into-view-if-needed";
+
+// src/utils/merge-refs.ts
+function mergeRefs(...refs) {
+  return (value) => {
+    refs.forEach((ref) => {
+      if (typeof ref === "function") {
+        ref(value);
+      } else if (ref !== null) {
+        ref.current = value;
+      }
+    });
+  };
+}
+
+// src/utils/use-anchor-observer.ts
+import { useEffect, useState } from "react";
+function useAnchorObserver(watch) {
+  const [activeAnchor, setActiveAnchor] = useState();
+  useEffect(() => {
+    const observer = new IntersectionObserver(
+      (entries) => {
+        setActiveAnchor((f) => {
+          for (const entry of entries) {
+            const aboveHalf = window.innerHeight / 2 > entry.boundingClientRect.y;
+            const active = aboveHalf && entry.isIntersecting;
+            if (active) {
+              return entry.target.id;
+            }
+          }
+          return f ?? watch[0];
+        });
+      },
+      { rootMargin: `0% 0% -80% 0%` }
+    );
+    for (const heading of watch) {
+      const element = document.getElementById(heading);
+      if (element !== null) {
+        observer.observe(element);
+      }
+    }
+    return () => {
+      observer.disconnect();
+    };
+  }, [watch]);
+  return activeAnchor;
+}
+
+// src/toc.tsx
 import { jsx } from "react/jsx-runtime";
-var ActiveAnchorContext = createContext({});
-var useActiveAnchor = (url) => {
-  const { activeAnchor } = useContext(ActiveAnchorContext);
-  return activeAnchor === url.split("#")[1];
-};
-var TOCProvider = forwardRef(
-  ({ toc, ...props }, ref) => {
-    const containerRef = useRef(null);
-    const mergedRef = mergeRefs(containerRef, ref);
-    return /* @__PURE__ */ jsx("div", { ref: mergedRef, ...props, children: /* @__PURE__ */ jsx(TOCScrollProvider, { toc, containerRef, children: props.children }) });
-  }
-);
-TOCProvider.displayName = "TOCProvider";
-function TOCScrollProvider({
-  toc,
+var ActiveAnchorContext = createContext(void 0);
+var ScrollContext = createContext({ current: null });
+function useActiveAnchor() {
+  return useContext(ActiveAnchorContext);
+}
+function ScrollProvider({
   containerRef,
   children
+}) {
+  return /* @__PURE__ */ jsx(ScrollContext.Provider, { value: containerRef, children });
+}
+function AnchorProvider({
+  toc,
+  children
 }) {
   const headings = useMemo(() => {
     return toc.map((item) => item.url.split("#")[1]);
   }, [toc]);
   const activeAnchor = useAnchorObserver(headings);
-  return /* @__PURE__ */ jsx(ActiveAnchorContext.Provider, { value: { containerRef, activeAnchor }, children });
+  return /* @__PURE__ */ jsx(ActiveAnchorContext.Provider, { value: activeAnchor, children });
 }
 var TOCItem = forwardRef(
-  ({ containerRef: container, ...props }, ref) => {
-    const { containerRef = container } = useContext(ActiveAnchorContext);
-    const active = useActiveAnchor(props.href);
+  ({ onActiveChange, ...props }, ref) => {
+    const containerRef = useContext(ScrollContext);
+    const activeAnchor = useActiveAnchor();
     const anchorRef = useRef(null);
     const mergedRef = mergeRefs(anchorRef, ref);
-    useEffect(() => {
+    const isActive = activeAnchor === props.href.split("#")[1];
+    useOnChange(isActive, (v) => {
       const element = anchorRef.current;
-      if (active && element && containerRef) {
+      if (!element) return;
+      if (v && containerRef.current) {
         scrollIntoView(element, {
           behavior: "smooth",
           block: "center",
@@ -56,14 +95,15 @@ var TOCItem = forwardRef(
           boundary: containerRef.current
         });
       }
-    }, [active, containerRef]);
-    return /* @__PURE__ */ jsx("a", { ref: mergedRef, "data-active": active, ...props, children: props.children });
+      onActiveChange?.(v);
+    });
+    return /* @__PURE__ */ jsx("a", { ref: mergedRef, "data-active": isActive, ...props, children: props.children });
   }
 );
 TOCItem.displayName = "TOCItem";
 export {
+  AnchorProvider,
+  ScrollProvider,
   TOCItem,
-  TOCProvider,
-  TOCScrollProvider,
   useActiveAnchor
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "12.5.5",
+  "version": "13.0.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -24,10 +24,6 @@
       "import": "./dist/toc.js",
       "types": "./dist/toc.d.ts"
     },
-    "./toc-internal": {
-      "import": "./dist/toc-internal.js",
-      "types": "./dist/toc-internal.d.ts"
-    },
     "./search/client": {
       "import": "./dist/search/client.js",
       "types": "./dist/search/client.d.ts"
@@ -84,9 +80,6 @@
       "toc": [
         "./dist/toc.d.ts"
       ],
-      "toc-internal": [
-        "./dist/toc-internal.d.ts"
-      ],
       "search/client": [
         "./dist/search/client.d.ts"
       ],
@@ -127,8 +120,8 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.4",
-    "@shikijs/rehype": "^1.11.0",
-    "@shikijs/transformers": "^1.11.0",
+    "@shikijs/rehype": "^1.11.1",
+    "@shikijs/transformers": "^1.11.1",
     "flexsearch": "0.7.21",
     "github-slugger": "^2.0.0",
     "negotiator": "^0.6.3",
@@ -138,7 +131,7 @@
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.1",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "^1.11.0",
+    "shiki": "^1.11.1",
     "swr": "^2.2.5",
     "unist-util-visit": "^5.0.0"
   },
@@ -150,7 +143,7 @@
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "20.14.11",
+    "@types/node": "20.14.12",
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "algoliasearch": "^4.24.0",

package/dist/chunk-V6DBK6TW.js

@@ -1,50 +0,0 @@
-// src/utils/merge-refs.ts
-function mergeRefs(...refs) {
-  return (value) => {
-    refs.forEach((ref) => {
-      if (typeof ref === "function") {
-        ref(value);
-      } else if (ref !== null) {
-        ref.current = value;
-      }
-    });
-  };
-}
-
-// src/utils/use-anchor-observer.ts
-import { useEffect, useState } from "react";
-function useAnchorObserver(watch) {
-  const [activeAnchor, setActiveAnchor] = useState();
-  useEffect(() => {
-    const observer = new IntersectionObserver(
-      (entries) => {
-        setActiveAnchor((f) => {
-          for (const entry of entries) {
-            const aboveHalf = window.innerHeight / 2 > entry.boundingClientRect.y;
-            const active = aboveHalf && entry.isIntersecting;
-            if (active) {
-              return entry.target.id;
-            }
-          }
-          return f ?? watch[0];
-        });
-      },
-      { rootMargin: `0% 0% -80% 0%` }
-    );
-    for (const heading of watch) {
-      const element = document.getElementById(heading);
-      if (element !== null) {
-        observer.observe(element);
-      }
-    }
-    return () => {
-      observer.disconnect();
-    };
-  }, [watch]);
-  return activeAnchor;
-}
-
-export {
-  mergeRefs,
-  useAnchorObserver
-};

package/dist/toc-internal.d.ts

@@ -1,28 +0,0 @@
-import * as react from 'react';
-import { ReactNode, RefObject, AnchorHTMLAttributes } from 'react';
-import { T as TableOfContents } from './get-toc-CM4X3hbw.js';
-
-/**
- * The id of active anchor (doesn't include hash)
- */
-declare function useActiveAnchor(): string | undefined;
-interface AnchorProviderProps {
-    toc: TableOfContents;
-    children?: ReactNode;
-}
-interface ScrollProviderProps {
-    /**
-     * Scroll into the view of container when active
-     */
-    containerRef: RefObject<HTMLElement>;
-    children?: ReactNode;
-}
-declare function ScrollProvider({ containerRef, children, }: ScrollProviderProps): React.ReactElement;
-declare function AnchorProvider({ toc, children, }: AnchorProviderProps): React.ReactElement;
-interface TOCItemProps extends Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> {
-    href: string;
-    onActiveChange?: (v: boolean) => void;
-}
-declare const TOCItem: react.ForwardRefExoticComponent<TOCItemProps & react.RefAttributes<HTMLAnchorElement>>;
-
-export { AnchorProvider, type AnchorProviderProps, ScrollProvider, type ScrollProviderProps, TOCItem, type TOCItemProps, useActiveAnchor };

package/dist/toc-internal.js

@@ -1,65 +0,0 @@
-import {
-  useOnChange
-} from "./chunk-KGMG4N3Y.js";
-import {
-  mergeRefs,
-  useAnchorObserver
-} from "./chunk-V6DBK6TW.js";
-import "./chunk-MLKGABMK.js";
-
-// src/toc-internal.tsx
-import { createContext, forwardRef, useContext, useMemo, useRef } from "react";
-import scrollIntoView from "scroll-into-view-if-needed";
-import { jsx } from "react/jsx-runtime";
-var ActiveAnchorContext = createContext(void 0);
-var ScrollContext = createContext({ current: null });
-function useActiveAnchor() {
-  return useContext(ActiveAnchorContext);
-}
-function ScrollProvider({
-  containerRef,
-  children
-}) {
-  return /* @__PURE__ */ jsx(ScrollContext.Provider, { value: containerRef, children });
-}
-function AnchorProvider({
-  toc,
-  children
-}) {
-  const headings = useMemo(() => {
-    return toc.map((item) => item.url.split("#")[1]);
-  }, [toc]);
-  const activeAnchor = useAnchorObserver(headings);
-  return /* @__PURE__ */ jsx(ActiveAnchorContext.Provider, { value: activeAnchor, children });
-}
-var TOCItem = forwardRef(
-  ({ onActiveChange, ...props }, ref) => {
-    const containerRef = useContext(ScrollContext);
-    const activeAnchor = useActiveAnchor();
-    const anchorRef = useRef(null);
-    const mergedRef = mergeRefs(anchorRef, ref);
-    const isActive = activeAnchor === props.href.split("#")[1];
-    useOnChange(isActive, (v) => {
-      const element = anchorRef.current;
-      if (!element) return;
-      if (v && containerRef.current) {
-        scrollIntoView(element, {
-          behavior: "smooth",
-          block: "center",
-          inline: "center",
-          scrollMode: "always",
-          boundary: containerRef.current
-        });
-      }
-      onActiveChange?.(v);
-    });
-    return /* @__PURE__ */ jsx("a", { ref: mergedRef, "data-active": isActive, ...props, children: props.children });
-  }
-);
-TOCItem.displayName = "TOCItem";
-export {
-  AnchorProvider,
-  ScrollProvider,
-  TOCItem,
-  useActiveAnchor
-};