Compare Versions - fumadocs-core

c2678c0: Improve llms.txt generation via remark-llms plugin
417f07a: Expose Markdown stringifier
bb07706: Include root items only once in Breadcrumb.

Previously, when includeRoot was set to true, the root item was added twice to breadcrumbs.
f065406: Support fuma-content integration

16.6.16

Patch Changes

054da73: Implement limit option on search servers

16.6.15

16.6.14

Patch Changes

8382363: [Remark Image] set placeholder to none by default

16.6.13

16.6.12

Patch Changes

ddb0f81: require explicit import for new search clients

16.6.11

Patch Changes

d35f30c: deprecate highlight on content highlighter
ae3e742: Support flexsearch server & client
269dfb3: Redesign search client adapter interface

16.6.8

Patch Changes

5453502: use Shiki.js v4

16.6.7

16.6.6

16.6.5

Patch Changes

1a614de: enforce MDX stringifier by default
6ab6692: fix edge case for Dynamic Link

Patch Changes

00c9a0f: Remove default rerank value from mixedbread search

16.6.0

Minor Changes

9241992: Support Markdown in search results

This deprecates the old contentWithHighlights field in search results, the highlights are marked with Markdown instead (e.g. Hello <mark>World</mark>).

Patch Changes

64a0057: [Remark Feedback] skip MDX elements by default to avoid interfering with component logic

16.5.4

Patch Changes

1ad8a38: Support server-side Mixedbread search API, deprecate client-side adapter
3e8efb0: [remark-structure] hotfix filter MDX elements

16.5.3

Patch Changes

be957f1: use mdast-util-to-markdown for accurate stringification

16.5.0

Minor Changes

9ba1250: Support Universal Shiki configuration

16.4.11

Patch Changes

a75a84d: fix duplicated transformer execution for fallback trees

16.4.10

Patch Changes

099fde7: [Page Tree] Extract index page from folder
6fd7e63: handle circular reference in page tree

16.4.9

Patch Changes

48dd0c2: fix incorrect page tree output

16.4.6

Patch Changes

ea57dbf: Introduce remark-feedback-block plugin

16.4.5

16.4.4

Patch Changes

cdc97e0: Improve experience with Shiki Twoslash

16.4.3

Patch Changes

f5dcb7c: fix update() source function types
7e08b2f: Add orama-cloud-legacy search integration for old Orama Cloud users

16.4.2

Patch Changes

590d36a: Support findSiblings() page tree utility
98d38ff: Support context-aware type-safe slugs function in loader()
446631d: Support <auto-files /> syntax in remark-mdx-files plugin
b16a32f: Switch to tsdown for bundling

16.4.1

16.4.0

Minor Changes

a3b7919: Update mixedbread integration API and docs

16.3.2

16.2.5

Patch Changes

7292424: Support MDX preset in Fumadocs Core

16.2.4

Patch Changes

da87713: Fix recursive checking on unknown types
d17499b: Fix basePath being ignored

16.2.3

Patch Changes

ef8eb6c: Expose Zod schema for page & meta data
e0c4c3a: [Remark Image] Respect title in images
4e2bca7: support collapsible in meta data

16.2.2

Patch Changes

464442b: Support client-side loader, including serialization layer
6c668e1: Support absolute URLs in search fetch client

16.2.1

16.2.0

16.1.0

Minor Changes

15bd183: [Loader API] Default the type of plugins to LoaderPluginOption[]

It should no longer enforce type checks on custom properties from your content source.

For creating fully typed plugins (with custom properties), use the following pattern:

import { loader } from 'fumadocs-core/source';
import { docs } from 'fumadocs-mdx:collections/server';
import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons';

export const source = loader(docs.toFumadocsSource(), {
  baseUrl: '/docs',
  plugins: ({ typedPlugin }) => [
    lucideIconsPlugin(),
    typedPlugin({
      // the plugin config
    }),
  ],
});

42ad84c: [Loader API] Refactor internal type parameters

Internal types like ContentStorage, PageTreeTransformer now use a single Config extends SourceConfig generic parameter.

It makes extending their parameters easier, this should not affect normal usages.

Patch Changes

2e01720: [Loader API] Support calling loader().getPage(slugs) with URI encoded slugs

16.0.15

Patch Changes

fe380da: feat(waku): WakuLink component to use unstable_prefetchOnEnter for prefetch
ade44d0: feat: enhance framework providers to accept custom Link components

16.0.14

Patch Changes

c3b8474: hotfix Tanstack Router usePathname inconsistency due to useMatch on layout.

16.0.13

16.0.12

Patch Changes

c5c00e9: Fix usePathname() adapter for Tanstack Start

16.0.11

Patch Changes

ff68f69: [Page Tree Builder] Fix node IDs are not unique across different locales
00058c8: Drop framework-side createContext

16.0.10

Patch Changes

733b01e: Support remarkDirectiveAdmonition, deprecate remarkAdmonition in favor of it.

16.0.9

16.0.8

Patch Changes

bc97236: Fix rehypeCode() tsdoc for lazy option
ca09b6a: Core: Support accessing MDX plugins separately at fumadocs-core/mdx-plugins/*
117ad86: Add support for using a custom GitHub API base URL

16.0.7

Patch Changes

f97cd1e: Support exportAs in remarkStructure.
f7e15e2: Support timeout in remark image options

16.0.5

Patch Changes

8221785: hotfix i18n middleware URL formating

16.0.4

Patch Changes

99971c7: Support external: to mark links as external in meta.json

16.0.3

16.0.2

Patch Changes

d511232: Fix i18n middleware search params handling

16.0.1

Patch Changes

45f0c1f: hotfix <DynamicCodeBlock /> Vite + React 19.2 compat issues

16.0.0

Major Changes

851897c: Remove fumadocs-core/sidebar API

why: no longer used by Fumadocs UI, and the abstraction isn't good enough.

migrate: The original component is mostly a wrapper of react-remove-scroll, you can use Shadcn UI for pre-built sidebars.
4049ccc: Remove fumadocs-core/server export
- getGithubLastEdit: Moved to fumadocs-core/content/github.
- getTableOfContents: Moved to fumadocs-core/content/toc.
- PageTree and page tree utilities: Moved to fumadocs-core/page-tree.
- TOCItemType, TableOfContents: Moved to fumadocs-core/toc.
- createMetadataImage: Use the Next.js Metadata API instead.
429c41a: Switch to Shiki JavaScript Regex engine by default

This is important for Cloudflare Worker compatibility, JavaScript engine is the new default over Oniguruma (WASM).
- rehype-code: replaced the experimentalJSEngine option with engine: js | oniguruma.
- fumadocs-core/highlight: use JS engine by default, drop custom engine support, use Shiki directly instead.
5210f18: Set minimal React.js version to 19.2.0

19.2 has multiple crucial updates that can improve Fumadocs' performance, and it should works seamlessly on mainstream React.js frameworks.

As a consequence, Next.js 16 is now the minimal version when using Fumadocs UI because Next.js always uses the internal canary version of React.js.
42f09c3: Remove deprecated APIs
- fumadocs-ui/page:
  - removed <DocsCategory />.
  - removed breadcrumbs.full option from <DocsPage />.
- fumadocs-core/search/algolia: renamed option document to indexName.
- fumadocs-core/search:
  - remove deprecated signature of createFromSource(): migrate to newer usage instead.
```
export function createFromSource<S extends LoaderOutput<LoaderConfig>>(
  source: S,
  pageToIndexFn?: (page: InferPageType<S>) => Awaitable<AdvancedIndex>,
  options?: Omit<Options<S>, 'buildIndex'>,
): SearchAPI;
```
  - remove deprecated parameters in useSearch(), pass them in the client object instead.
- fumadocs-core/highlight: remove deprecated withPrerenderScript and loading options from useShiki().
- fumadocs-core/i18n: removed createI18nMiddleware, import from fumadocs-core/i18n/middleware instead.
- fumadocs-core/source:
  - removed deprecated transformers, pageTree.attach* options from loader().
  - removed deprecated page.file property.
  - removed FileInfo & parseFilePath utilities.

55afd8a: Migrate to New Orama Cloud

@orama/core is the new version of Orama Cloud client. See their docs for details.

When using Fumadocs' Orama Cloud integration, you need to use the new client instead:

import { sync } from 'fumadocs-core/search/orama-cloud';
import { OramaCloud } from '@orama/core';

// update this
const orama = new OramaCloud({
  projectId: '<project id>',
  apiKey: '<private api key>',
});

await sync(orama, {
  index: '<data source id>',
  documents: records,
});

Minor Changes

cbc93e9: Disable single by default on fumadocs-core/toc API

Patch Changes

230c6bf: let getPageTreePeers handle i18n

15.8.4

Patch Changes

ce2be59: Loader Plugin: support name & config options
31b9494: Support multiple() for multiple sources in same loader()

15.8.3

Patch Changes

a3a14e7: Bump deps

15.8.2

Patch Changes

ad9a004: Deprecate fumadocs-core/server export

It will be removed on Fumadocs 16, as some APIs under the /server export are actually available (and even used) under browser environment.

A more modularized design will be introduced over the original naming.
- getGithubLastEdit: Moved to fumadocs-core/content/github.
- getTableOfContents: Moved to fumadocs-core/content/toc.
- PageTree and page tree utilities: Moved to fumadocs-core/page-tree.
- TOCItemType, TableOfContents: Moved to fumadocs-core/toc.
- createMetadataImage: Deprecated, use the Next.js Metadata API instead.
90cf1fe: Support Negotiation API
747bdbc: Support lucide react icons plugin for loader()

15.8.1

Patch Changes

71bce86: Make loader().getPages() to return pages from all languages when locale is not specified
f04547f: Publish plugins API on loader()

15.8.0

Minor Changes

d1ae3e8: Move SortedResult and other search-related types to fumadocs-core/search

This also exposed the search result highlighter API, you may now use it for highlighting results of your own search integration

Old export will be kept until the next major release.
51268ec: Breadcrumbs API: default includePage to false.

Patch Changes

655bb46: [Internal] parseCodeBlockAttributes include null values, restrict rehype-code to only parse title and tab attributes.
6548a59: Support breadcrumbs for Search API
51268ec: Breadcrumbs API: Fix root folders being filtered when includeRoot is set to true.

15.7.13

Patch Changes

982aed6: Fix source.getPageByHref() return no result without explicit language

15.7.12

Patch Changes

846b28a: Support multiple codeblocks in same tab
2b30315: Support mode option in search server

15.7.11

15.7.10

Patch Changes

c948f59: Try to workaround legacy i18n middleware under /i18n export without breaking changes

15.7.9

Patch Changes

d135efd: transformerIcon supports SVG string to extend codeblock icons
4082acc: Expose highlightHast API

15.7.8

Patch Changes

f65778d: Link improve external link detection by enabling it on any protocols
e4c12a3: Add framework adapters to optional peer deps

15.7.7

Patch Changes

0b53056: Support remarkMdxMermaid - convert mermaid codeblocks into <Mermaid /> component
3490285: Support remarkMdxFiles - convert files codeblocks into <Files /> component

15.7.6

15.7.5

Patch Changes

cedc494: Hotfix URL normalization logic

15.7.4

15.7.3

Patch Changes

6d97379: unify remark nodes parsing & improve types
e776ee5: Fix langAlias not being passed to Shiki rehype plugin

15.7.2

Patch Changes

88b5a4e: Fix duplicate pages in page tree when referencing subpage in meta.json and using ... or adding the subfolder again
039b24b: Fix failed to update page tree from loader()
08eee2b: [remark-npm] Enable npm install prefix fallback only on old alias

15.7.1

Patch Changes

195b090: Support a list of source for loader() API
e1c84a2: Support fallbackLanguage for loader() i18n API

15.7.0

Minor Changes

514052e: Include locale code into page.path

Previously when i18n is enabled, page.path is not equal to the virtual file paths you passed into loader():
```
const source = loader({
  source: {
    files: [
      {
        path: 'folder/index.cn.mdx',
        // ...
      },
    ],
  },
});

console.log(source.getPages('cn'));
// path: folder/index.mdx
```
This can be confusing, the only solution to obtain the original path was page.absolutePath.

From now, the page.path will also include the locale code:
```
const source = loader({
  source: {
    files: [
      {
        path: 'folder/index.cn.mdx',
        // ...
      },
    ],
  },
});

console.log(source.getPages('cn'));
// path: folder/index.cn.mdx
```
While this change doesn't affect intended API usages, it may lead to minor bugs when advanced usage/hacks involved around page.path.
e785f98: Introduce page tree fallback API

Page tree is a tree structure.

Previously, when an item is excluded from page tree, it is isolated entirely that you cannot display it at all.

With the new fallback API, isolated pages will go into fallback page tree instead:
```
{
  "children": [
    {
      "type": "page",
      "name": "Introduction"
    }
  ],
  "fallback": {
    "children": [
      {
        "type": "page",
        "name": "Hidden Page"
      }
    ]
  }
}
```
Items in fallback are invisible unless you've opened its item.

0531bf4: Introduce page tree transformer API

You can now define page tree transformer.

export const source = loader({
  // ...
  pageTree: {
    transformers: [
      {
        root(root) {
          return root;
        },
        file(node, file) {
          return node;
        },
        folder(node, dir, metaPath) {
          return node;
        },
        separator(node) {
          return node;
        },
      },
    ],
  },
});

50eb07f: Support type-safe i18n config

// lib/source.ts
import { defineI18n } from 'fumadocs-core/i18n';

export const i18n = defineI18n({
  defaultLanguage: 'en',
  languages: ['en', 'cn'],
});

// root layout
import { defineI18nUI } from 'fumadocs-ui/i18n';
import { i18n } from '@/lib/i18n';

const { provider } = defineI18nUI(i18n, {
  translations: {
    cn: {
      displayName: 'Chinese',
      search: 'Translated Content',
    },
    en: {
      displayName: 'English',
    },
  },
});

function RootLayout({ children }: { children: React.ReactNode }) {
  return <RootProvider i18n={provider(lang)}>{children}</RootProvider>;
}

Although optional, we highly recommend you to refactor the import to i18n middleware:

// here!
import { createI18nMiddleware } from 'fumadocs-core/i18n/middleware';
import { i18n } from '@/lib/i18n';

export default createI18nMiddleware(i18n);

Patch Changes

e254c65: Simplify Source API storage management
ec75601: Support ReactNode for icons in page tree
67df155: createFromSource support async buildIndex and Fumadocs MDX Async Mode
b109d06: Redesign useShiki & <DynamicCodeBlock /> to use React 19 hooks

15.6.12

15.6.11

15.6.10

Patch Changes

569bc26: Improve remark-image: (1) append public URL to output src if it is a URL. (2) ignore if failed to obtain SVG size.
817c237: Support search result highlighting.

Result nodes now have a contentWithHighlights property, you can render it with custom renderer, or a default one provided on Fumadocs UI.

15.6.9

Patch Changes

0ab2cdd: remove waku & tanstack peer dependency temporarily (see https://github.com/fuma-nama/fumadocs/issues/2144)

15.6.8

15.6.7

Patch Changes

6fa1442: Support to override <HideIfEmpty /> scripts nonce with <HideIfEmptyProvider />

15.6.6

Patch Changes

1b0e9d5: Add mixedbread integration

15.6.5

Patch Changes

658fa96: Support custom options for error handling for remark-image

Patch Changes

1a902ff: Fix static export map

15.6.0

Minor Changes

f8d1709: Redesigned Codeblock Tabs

Instead of relying on Tabs component, it supports a dedicated tabs component for codeblocks:
```
<CodeBlockTabs>
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="value">Name</CodeBlockTabsTrigger>
  </CodeBlockTabsList>
  <CodeBlockTab value="value" asChild>
    <CodeBlock>...</CodeBlock>
  </CodeBlockTab>
</CodeBlockTabs>
```
The old usage is not deprecated, you can still use them while Fumadocs' remark plugins will generate codeblock tabs using the new way.

Patch Changes

d0f8a15: Enable remarkNpm by default, replace remarkInstall with it.
84918b8: Support passing tag to search client/server as string array

15.5.5

Patch Changes

0d3f76b: Fix wrong indexing of file system

15.5.4

Patch Changes

35c3c0b: Support handling duplicated slugs and conflicts such as dir/index.mdx vs dir.mdx

15.5.3

Patch Changes

7d1ac21: hotfix paths not being normalized on Windows

15.5.2

Patch Changes

7a45921: Add absolutePath and path properties to pages, mark file as deprecated
1b7bc4b: Add @types/react to optional peer dependency to avoid version conflict in monorepos

15.5.1

Patch Changes

b4916d2: Move hide-if-empty component to Fumadocs Core
8738b9c: Always encode generated slugs for non-ASCII characters in loader()

a66886b: Deprecate other parameters for useDocsSearch()

The new usage passes options to a single object, improving the readability:

import { useDocsSearch } from 'fumadocs-core/search/client';

const { search, setSearch, query } = useDocsSearch({
  type: 'fetch',
  locale: 'optional',
  tag: 'optional',
  delayMs: 100,
  allowEmpty: false,
});

15.5.0

15.4.2

Patch Changes

0ab6c7f: Improve performance by using shallow compare on useOnChange by default

15.4.1

15.4.0

Minor Changes

961b67e: Bump algolia search to v5

This also introduced changes to some APIs since algoliasearch v4 and v5 has many differences.

Now we highly recommend to pass an index name to sync():

import { algoliasearch } from 'algoliasearch';
import { sync } from 'fumadocs-core/search/algolia';
const client = algoliasearch('id', 'key');

void sync(client, {
  indexName: 'document',
  documents: records,
});

For search client, pass them to searchOptions:

'use client';

import { liteClient } from 'algoliasearch/lite';
import type { SharedProps } from 'fumadocs-ui/components/dialog/search';
import SearchDialog from 'fumadocs-ui/components/dialog/search-algolia';

const client = liteClient(appId, apiKey);

export default function CustomSearchDialog(props: SharedProps) {
  return (
    <SearchDialog
      searchOptions={{
        client,
        indexName: 'document',
      }}
      {...props}
      showAlgolia
    />
  );
}

Patch Changes

1b999eb: Introduce <Markdown /> component
7d78bc5: Improve createRelativeLink and getPageByHref for i18n usage

15.3.4

15.3.3

Patch Changes

4ae7b4a: Support MDX in codeblock tab value

15.3.2

Patch Changes

c25d678: Support Shiki focus notation transformer by default

15.3.1

Patch Changes

3372792: Support line numbers in codeblock

15.3.0

Patch Changes

c05dc03: Improve error message of remark image

15.2.15

Patch Changes

50db874: Remove placeholder space for codeblocks
79e75c3: Improve default MDX attribute indexing strategy for remarkStructure

15.2.14

Patch Changes

6ea1718: Fix type inference for pageTree.attachFile in loader()

15.2.13

15.2.12

Patch Changes

acff667: Deprecate createFromSource(source, pageToIndex, options)

Migrate:

import { source } from '@/lib/source';
import { createFromSource } from 'fumadocs-core/search/server';

// from
export const { GET } = createFromSource(
  source,
  (page) => ({
    title: page.data.title,
    description: page.data.description,
    url: page.url,
    id: page.url,
    structuredData: page.data.structuredData,
    // use your desired value, like page.slugs[0]
    tag: '<value>',
  }),
  {
    // options
  },
);

// to
export const { GET } = createFromSource(source, {
  buildIndex(page) {
    return {
      title: page.data.title,
      description: page.data.description,
      url: page.url,
      id: page.url,
      structuredData: page.data.structuredData,
      // use your desired value, like page.slugs[0]
      tag: '<value>',
    };
  },
  // other options
});

15.2.11

Patch Changes

07cd690: Support separators without name

Patch Changes

ec85a6c: support more options on remarkStructure
e1a61bf: Support remarkSteps plugin

15.2.6

Patch Changes

d49f9ae: Fix order of <I18nProvider />
b07e98c: fix loader().getNodePage() returning undefined for other locales
3a4bd88: Fix wrong index files output in i18n page tree generation

15.2.5

Patch Changes

c66ed79: Fix removeScrollOn on sidebar primitive

15.2.4

Patch Changes

1057957: Fix type problems on dynamic codeblock

15.2.3

15.2.2

Patch Changes

0829544: deprecate blockScrollingWidth in favour of removeScrollOn

15.2.1

15.2.0

Minor Changes

2fd325c: Enable lazy on rehypeCode by default
a7cf4fa: Support other frameworks via FrameworkProvider

15.1.3

Patch Changes

b734f92: support mdxJsxFlowElement in remarkStructure

15.1.2

Patch Changes

3f580c4: Support directory-based i18n routing

15.1.1

Patch Changes

c5add28: use internal store for Shiki highlighter instances
f3cde4f: Support markdown files with default local code in file name
7c8a690: Improve file info interface
b812457: Remove Next.js usage from search server

15.1.0

Minor Changes

f491f6f: Lazy build page tree by default
f491f6f: Support getPageByHref() on loader API

Patch Changes

f491f6f: Fix findNeighbour() doesn't exclude other nodes of another root

15.0.18

15.0.17

Patch Changes

72f79cf: Support Orama Cloud crawler index

15.0.16

15.0.15

Patch Changes

9f6d39a: Fix peer deps
2035cb1: remove hook-level cache from useDocsSearch()

15.0.14

Patch Changes

37dc0a6: Update image-size to v2
796cc5e: Upgrade to Orama v3
2cc0be5: Support to add custom serialization to remarkStructure via data._string

15.0.13

15.0.12

Patch Changes

3534a10: Move fumadocs-core highlighting utils to fumadocs-core/highlight and fumadocs-core/highlight/client
93952db: Generate a $id attribute to page tree nodes

15.0.11

15.0.10

Patch Changes

d95c21f: add initOrama option to static client

15.0.9

15.0.8

15.0.7

Patch Changes

5deaf40: Support icons in separators of meta.json

15.0.6

Patch Changes

08236e1: Support custom toc settings in headings
a06af26: Support pages without title

Minor Changes

581f4a5: Support code block tabs without hardcoding <Tabs /> items

migrate: Use the remarkCodeTab plugin.

before:

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<Tabs items={["Tab 1", "Tab 2"]}>

```ts tab
console.log('A');
```

```ts tab
console.log('B');
```

</Tabs>

after:

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

```ts tab="Tab 1"
console.log('A');
```

```ts tab="Tab 2"
console.log('B');
```

Patch Changes

5b8cca8: Fix remarkAdmonition missing some types from Docusaurus
a763058: Support reversed rest items in meta.json

14.7.7

14.7.6

Patch Changes

b9601fb: Update Shiki

14.7.5

Patch Changes

777188b: [Page Tree Builder] Inline folders without children

14.7.4

Patch Changes

bb73a72: Fix search params being ignored in middleware redirection
69bd4fe: Support source.getPageTree() function

14.7.3

Patch Changes

041f230: Support trailing slash

14.7.2

Patch Changes

14b280c: Revert default i18n config

14.7.1

Patch Changes

72dc093: Add chinese i18n configuration for Orama search if not specified

14.7.0

Minor Changes

97ed36c: Remove defaults from loader and deprecate rootDir options

14.6.8

14.6.7

Patch Changes

5474343: Export dynamic-link

14.6.6

14.6.5

Patch Changes

969da26: Improve i18n api

14.6.4

Patch Changes

b71064a: Support remark plugins & vfile input on getTableOfContents

14.6.3

14.6.2

Patch Changes

2357d40: Fix typings of HighlightOptions

14.6.1

14.6.0

Minor Changes

bebb16b: Add support for pre-rendering to useShiki hook
050b326: Support codeblock tab meta without value

Patch Changes

4dfde6b: support additional components option of Orama search
4766292: Support React 19

14.5.6

Patch Changes

9a18c14: Downgrade Orama to v2 to fix external tokenizers

Patch Changes

ca94bfd: Support sync usage of getTableOfContents

14.2.0

Minor Changes

e248a0f: Support Orama Cloud integration

14.1.1

Patch Changes

1573d63: Support URL format publicDir in Remark Image plugin

14.0.1

14.0.0

Major Changes

e45bc67: Remove deprecated fumadocs-core/middleware export

migrate: Use fumadocs-core/i18n.
d9e908e: Remove deprecated languages and defaultLanguage option from loader

migrate: Use I18n config API

9a0b09f: Change usage of useDocsSearch

why: Allow static search

migrate:

Pass client option, it can be algolia, static, or fetch (default).

import { useDocsSearch } from 'fumadocs-core/search/client';

const { search, setSearch, query } = useDocsSearch({
  type: 'fetch',
  api: '/api/search', // optional
});

9a0b09f: Remove Algolia Search Client

why: Replace by the new search client

migrate:

import { useDocsSearch } from 'fumadocs-core/search/client';

const { search, setSearch, query } = useDocsSearch({
  type: 'algolia',
  index,
  ...searchOptions,
});

9a0b09f: Refactor import path of fumadocs-core/search-algolia/server to fumadocs-core/search/algolia
d9e908e: Improved usage for createI18nSearchAPI (replaced createI18nSearchAPIExperimental)
d9e908e: Replace fumadocs-core/search/shared with fumadocs-core/server

Minor Changes

d9e908e: Create search api from source (Support i18n without modifying search route handler)
367f4c3: Support referencing original page/meta from page tree nodes
e1ee822: Support hast nodes in toc variable
979e301: Replace flexearch with Orama
979e301: Support static search (without server)
d9e908e: Support creating metadata API from sources

Patch Changes

f949520: Support Shiki diff transformer
e612f2a: Make compatible with Next.js 15
8ef00dc: Apply hideLocale to Source getPage APIs
15781f0: Fix breadcrumb empty when includePage isn't specified
be820c4: Bump deps

13.4.10

Patch Changes

6231ad3: fix(types): PageData & MetaData exactOptionalPropertyTypes compat

13.4.9

Patch Changes

083f04a: Fix link items text

13.4.8

Patch Changes

78e59e7: Support to add icons to link items in meta.json

13.4.7

Patch Changes

6e1923e: Improve anchors observer

13.4.6

Patch Changes

afb697e: Fix Next.js 14.2.8 dynamic import problems
daa66d2: Support generating static params automatically with Source API

13.4.5

13.4.4

Patch Changes

729928e: Fix build error without JS engine

13.4.3

13.4.2

Patch Changes

7dabbc1: Remark Image: Support relative imports
0c251e5: Bump deps
3b56170: Support to enable experiment Shiki JS engine

13.4.1

Patch Changes

95dbba1: Scan table into search indexes by default

13.4.0

13.3.3

Patch Changes

f8cc167: Ignore numeric locale file name

13.3.2

Patch Changes

0e0ef8c: Support headless search servers

13.3.1

13.3.0

Minor Changes

fd46eb6: Export new createI18nSearchAPIExperimental API for i18n config
fd46eb6: Introduce i18n config for Core APIs
fd46eb6: Deprecated languages and defaultLanguage option on Source API, replaced with i18n config
fd46eb6: Move I18n middleware to fumadocs-core/i18n
9aae448: Support multiple toc active items
c542561: Use cookie to store active locale on always mode

Patch Changes

4916f84: Improve Source API performance

13.2.2

Patch Changes

36b771b: Remark Image: Support relative import path
61b91fa: Improve Fumadocs OpenAPI support

13.2.1

Patch Changes

17fa173: Remark Image: Support fetching image size of external urls

13.2.0

Patch Changes

96c9dda: Change Heading scroll margins

13.1.0

Patch Changes

f280191: Page Tree Builder: Sort folders to bottom

13.0.7

Patch Changes

37bbfff: Improve active anchor observer

13.0.6

13.0.5

Patch Changes

2cf65f6: Support debounce value on algolia search client

13.0.4

Patch Changes

5355391: Support indexing description field on documents

13.0.3

Patch Changes

978342f: Type file system utilities (Note: This is an internal module, you're not supposed to reference it)

13.0.2

Patch Changes

4819820: Page Tree Builder: Fallback to page icon when metadata doesn't exist

13.0.1

13.0.0

Major Changes

09c3103: Change usage of TOC component

why: Improve the flexibility of headless components

migrate:

Instead of

import * as Base from 'fumadocs-core/toc';

return (
  <Base.TOCProvider>
    <Base.TOCItem />
  </Base.TOCProvider>
);

Use

import * as Base from 'fumadocs-core/toc';

return (
  <Base.AnchorProvider>
    <Base.ScrollProvider>
      <Base.TOCItem />
      <Base.TOCItem />
    </Base.ScrollProvider>
  </Base.AnchorProvider>
);

b02eebf: Remove deprecated option defaultLang

why: The default language feature has been supported by Shiki Rehype integration, you should use it directly.

migrate: Rename to defaultLanguage.

Minor Changes

c714eaa: Support Remark Admonition plugin

12.5.6

12.5.5

12.5.4

Patch Changes

fccdfdb: Improve TOC Popover design
2ffd5ea: Support folder group on Page Tree Builder

12.5.3

12.5.2

Patch Changes

a5c34f0: Support specifying the url of root node when breadcrumbs have includeRoot enabled

12.5.1

12.5.0

Minor Changes

b9fa99d: Support tag facet field for Algolia Search Integration

Patch Changes

525925b: Support including root folder into breadcrumbs

12.4.2

Patch Changes

503e8e9: Support keywords API in advanced search

Patch Changes

90d51cb: Fix problem with I18n middleware & language toggle

12.3.2

Patch Changes

ca7d0f4: Support resolving async search indexes

12.3.1

Patch Changes

cf852f6: Add configurable delayMs Parameter for Debounced Search Performance

12.3.0

Minor Changes

ce3c8ad: Page Tree Builder: Support defaultLanguage option
ce3c8ad: Support hiding locale prefixes with I18n middleware

Minor Changes

b70ff06: Support !name to hide pages on meta.json

12.1.3

12.1.2

Patch Changes

b4856d1: Fix createGetUrl wrong locale position

12.1.1

Patch Changes

a39dbcb: Export loadFiles from Source API

12.1.0

Minor Changes

0a377a9: Support writing code blocks as a <Tab /> element.

import { Tabs } from 'fumadocs-ui/components/tabs';

<Tabs items={["Tab 1", "Tab 2"]}>

```js tab="Tab 1"
console.log('Hello');
```

```js tab="Tab 2"
console.log('Hello');
```

</Tabs>

This is same as wrapping the code block in a <Tab /> component.

0a377a9: Pass the icon prop to code blocks as HTML instead of MDX attribute.

why: Only MDX flow elements support attributes with JSX value, like:
```
<Pre icon={<svg />}>...</Pre>
```
As Shiki outputs hast elements, we have to convert the output of Shiki to a MDX flow element so that we can pass the icon property.

Now, rehype-code passes a HTML string instead of JSX, and render it with dangerouslySetInnerHTML:
```
<Pre icon="<svg />">...</Pre>
```
migrate: Not needed, it should work seamlessly.

12.0.7

12.0.6

Patch Changes

7a29b79: Remove default language from source.getLanguages
b0c1242: Support Next.js 15 cache behaviour in getGithubLastEdit

12.0.5

12.0.4

Patch Changes

72dbaf1: Support ReactNode in page tree, table of contents and breadcrumb type definitions
51ca944: Support including separators in breadcrumbs

12.0.3

Patch Changes

053609d: Rename defaultLang to defaultLanguage

12.0.2

12.0.1

12.0.0

Major Changes

98430e9: Remove minWidth deprecated option from Sidebar component.

migrate: Use blockScrollingWidth instead

Minor Changes

57eb762: Support attaching custom properties during page tree builder process

Patch Changes

d88dfa6: Support attaching id property to page trees
ba20694: Remark Headings: Support code syntax in headings

11.3.2

Patch Changes

1b8e12b: Use display: grid for codeblocks

11.3.1

11.3.0

Minor Changes

917d87f: Rename sidebar primitive minWidth prop to blockScrollingWidth

Patch Changes

88008b1: Fix ESM compatibility problems in i18n middleware
944541a: Add dynamic page url according to locale
07a9312: Improve Search I18n utilities

11.1.2

11.1.1

Patch Changes

8ef2b68: Bump deps
26f464d: Support relative paths in meta.json
26f464d: Support non-external link in meta.json

11.1.0

11.0.8

Patch Changes

98258b5: Fix regex problems

11.0.7

Patch Changes

f7c2c5c: Fix custom heading ids conflicts with MDX syntax

11.0.6

Patch Changes

5653d5d: Support customising heading id in headings
5653d5d: Support custom heading slugger

11.0.5

11.0.4

Patch Changes

7b61b2f: Migrate fumadocs-ui to fully ESM, adding support for ESM tailwind.config file

Major Changes

2d8df75: Remove cwd option from remark-dynamic-content

why: Use cwd from vfile

migrate: Pass the cwd option from remark instead

92cb12f: Simplify Source API virtual storage.

why: Improve performance

migrate:

- storage.write('path.mdx', { type: 'page', ... })
- storage.readPage('page')
+ storage.write('path.mdx', 'page', { ... })
+ storage.read('page', 'page')

Transformers can now access file loader options.

load({
  transformers: [
    ({ storage, options }) => {
      options.getUrl();
      options.getSlugs();
    },
  ],
});

f75287d: Introduce fumadocs-docgen package.

Offer a better authoring experience for advanced use cases.
- Move remark-dynamic-content and remark-install plugins to the new package fumadocs-docgen.
- Support Typescript generator by default
Usage

Add the remarkDocGen plugin to your remark plugins.
```
import { remarkDocGen, fileGenerator } from "fumadocs-docgen";

remark().use(remarkDocGen, { generators: [fileGenerator()] });
```
Generate docs with code blocks.
```
```json doc-gen:<generator>
{
  // options
}
```
```
Migrate

For remarkDynamicContent, enable fileGenerator and use this syntax:
```
```json doc-gen:file
{
  "file": "./path/to/my-file.txt"
}
```
```
For remarkInstall, it remains the same:
```
import { remarkInstall } from "fumadocs-docgen";
```
2d8df75: Remove support for getTableOfContentsFromPortableText

why: Sanity integration should be provided by 3rd party integrations

migrate: Use built-in sources, or write a custom implementation

10.1.3

Patch Changes

bbad52f: Support bun in remark-install plugin

10.1.2

10.1.1

Patch Changes

779c599: Mark getTableOfContentsFromPortableText deprecated
0c01300: Fix remark-dynamic-content ignored code blocks
779c599: Support relative resolve path for remark-dynamic-content

10.1.0

10.0.5

Patch Changes

e47c62f: Improve remark plugin typings

10.0.4

10.0.3

Patch Changes

6f321e5: Fix type errors of flexseach

10.0.2

Patch Changes

10e099a: Remove deprecated options from fumadocs-core/toc

10.0.1

Patch Changes

c9b7763: Update to Next.js 14.1.0
0e78dc8: Support customising search API URL
d8483a8: Remove undefined values from page tree

10.0.0

Major Changes

321d1e1f: Move Typescript integrations to fumadocs-typescript

why: It is now a stable feature

migrate: Use fumadocs-typescript instead.

- import { AutoTypeTable } from "fumadocs-ui/components/auto-type-table"
+ import { AutoTypeTable } from "fumadocs-typescript/ui"

Minor Changes

b5d16938: Support external link in pages property

9.1.0

Minor Changes

909b0e35: Support duplicated names with meta and page files
1c388ca5: Support defaultOpen for folder nodes

Patch Changes

691f12aa: Source API: Support relative paths as root directory

9.0.0

8.3.0

8.2.0

Minor Changes

5c24659: Support code block icons

8.1.1

8.1.0

Minor Changes

eb028b4: Migrate to shiki
054ec60: Support generating docs for Typescript file

Patch Changes

6c5a39a: Rename Git repository to fumadocs

8.0.0

Major Changes

2ea9437: Migrate to rehype-shikiji
- Dropped support for inline code syntax highlighting
- Use notation-based word/line highlighting instead of meta string
Before:
```
```ts /config/ {1}
const config = 'Hello';

something.call(config);
```
```
After:
```
```ts
// [!code word:config]
const config = 'Hello'; // [!code highlight]

something.call(config);
```
```
Read the docs of Shikiji for more information.

cdff313: Separate Contentlayer integration into another package

why: As Fumadocs MDX is the preferred default source, Contentlayer should be optional.

migrate:

Install fumadocs-contentlayer.

- import { createContentlayerSource } from "fumadocs-core/contentlayer"
+ import { createContentlayerSource } from "fumadocs-contentlayer"

- import { createConfig } from "fumadocs-core/contentlayer/configuration"
+ import { createConfig } from "fumadocs-contentlayer/configuration"

2b11c20: Rename to Fumadocs

next-docs-zeta -> fumadocs-core

next-docs-ui -> fumadocs-ui

next-docs-mdx -> fumadocs-mdx

@fuma-docs/openapi -> fumadocs-openapi

create-next-docs-app -> create-fumadocs-app

Minor Changes

1a346a1: Add remark-image plugin that converts relative image urls into static image imports (Inspired by Nextra)