Compare Versions - fumadocs-ui

8bdee70: Implement renderer API for replacing layout components, deprecate old options
bdffeba: Improved defineI18nUI() usage: allow language translations to be defined at root config.
f45d703: stablize Shiki factory API

Patch Changes

3d17757: Improve <GithubInfo /> component
Updated dependencies [f45d703]
Updated dependencies [45aa454]
- fumadocs-core@16.7.0

16.6.17

Patch Changes

c3a723e: fix codeblock RSC highlighting
Updated dependencies [c2678c0]
Updated dependencies [417f07a]
Updated dependencies [bb07706]
Updated dependencies [f065406]
- fumadocs-core@16.6.17

16.6.16

Patch Changes

Updated dependencies [054da73]
- fumadocs-core@16.6.16

16.6.15

Patch Changes

86d3abb: fix broken tsdown CSS logic
- fumadocs-core@16.6.15

16.6.14

Patch Changes

a02048c: UI: override MDX types by default
02201df: Simplify i18n setup
Updated dependencies [8382363]
- fumadocs-core@16.6.14

16.6.13

Patch Changes

2702b28: Bundle page actions into UI
- fumadocs-core@16.6.13

16.6.12

Patch Changes

Updated dependencies [ddb0f81]
- fumadocs-core@16.6.12

16.6.11

Patch Changes

Updated dependencies [d35f30c]
Updated dependencies [ae3e742]
Updated dependencies [269dfb3]
- fumadocs-core@16.6.11

16.6.8

Patch Changes

5453502: use Shiki.js v4
Updated dependencies [5453502]
- @fumadocs/tailwind@0.0.3
- fumadocs-core@16.6.8

16.6.7

Patch Changes

8faa2e4: fix codeblock highlight styles
- fumadocs-core@16.6.7

16.6.6

Patch Changes

38bd784: improve flux layout
- fumadocs-core@16.6.6

16.6.5

Patch Changes

Updated dependencies [1a614de]
Updated dependencies [6ab6692]
- fumadocs-core@16.6.5

16.6.4

Patch Changes

8f8e7f0: fix accessibility issues
- fumadocs-core@16.6.4

16.6.3

Patch Changes

1c26656: Extend grid of docs layout to 5 columns
- fumadocs-core@16.6.3

16.6.2

Patch Changes

cfc5590: Implement active on sidebar link items
- fumadocs-core@16.6.2

16.6.1

Patch Changes

20cd4d6: Support ID & @fumadocsHref tag in type tables
Updated dependencies [00c9a0f]
- fumadocs-core@16.6.1

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

Updated dependencies [9241992]
Updated dependencies [64a0057]
- fumadocs-core@16.6.0

16.5.4

Patch Changes

Updated dependencies [1ad8a38]
Updated dependencies [3e8efb0]
- fumadocs-core@16.5.4

16.5.3

Patch Changes

Updated dependencies [be957f1]
- fumadocs-core@16.5.3

16.5.0

Minor Changes

9ba1250: Support Universal Shiki configuration

Patch Changes

Updated dependencies [85cc22f]
Updated dependencies [9ba1250]
- @fumadocs/ui@16.5.0
- fumadocs-core@16.5.0

16.4.11

Patch Changes

Updated dependencies [a75a84d]
- fumadocs-core@16.4.11
- @fumadocs/ui@16.4.11

16.4.10

Patch Changes

430a5f1: support on on docs layout
Updated dependencies [099fde7]
Updated dependencies [6fd7e63]
- fumadocs-core@16.4.10
- @fumadocs/ui@16.4.10

16.4.9

Patch Changes

Updated dependencies [48dd0c2]
- fumadocs-core@16.4.9
- @fumadocs/ui@16.4.9

16.4.6

Patch Changes

Updated dependencies [ea57dbf]
- fumadocs-core@16.4.6
- @fumadocs/ui@16.4.6

16.4.5

Patch Changes

9f06196: fix footer.children props
- fumadocs-core@16.4.5
- @fumadocs/ui@16.4.5

16.4.4

Patch Changes

c804ac6: expose useAutoScroll()
Updated dependencies [cdc97e0]
- fumadocs-core@16.4.4
- @fumadocs/ui@16.4.4

16.4.3

Patch Changes

84ce624: Keep default prefetch behaviours in sidebar
Updated dependencies [f5dcb7c]
Updated dependencies [7e08b2f]
- fumadocs-core@16.4.3
- @fumadocs/ui@16.4.3

16.4.2

Patch Changes

b16a32f: Switch to tsdown for bundling
Updated dependencies [590d36a]
Updated dependencies [98d38ff]
Updated dependencies [446631d]
Updated dependencies [b16a32f]
- fumadocs-core@16.4.2
- @fumadocs/ui@16.4.2

16.4.1

Patch Changes

Updated dependencies [0a3adb8]
- @fumadocs/ui@16.4.1
- fumadocs-core@16.4.1

16.4.0

Patch Changes

da98fe2: Support onSelect prop in <SearchDialog /> component
Updated dependencies [a3b7919]
- fumadocs-core@16.4.0
- @fumadocs/ui@16.4.0

16.3.2

Patch Changes

7c78045: Support custom renderer for title in layouts
- @fumadocs/ui@16.3.2
- fumadocs-core@16.3.2

16.2.5

Patch Changes

8469c6d: fix shadcn ui preset
Updated dependencies [7292424]
- fumadocs-core@16.2.5

16.2.4

Patch Changes

Updated dependencies [da87713]
Updated dependencies [d17499b]
- fumadocs-core@16.2.4

16.2.3

Patch Changes

4e2bca7: support collapsible in meta data
Updated dependencies [ef8eb6c]
Updated dependencies [e0c4c3a]
Updated dependencies [4e2bca7]
- fumadocs-core@16.2.3

16.2.2

Patch Changes

19db270: Align menu behaviour on notebook layout with home layout
Updated dependencies [464442b]
Updated dependencies [6c668e1]
- fumadocs-core@16.2.2

16.2.1

Patch Changes

556cb6b: Fix missing default colors
c6120ff: Add sidebar animation back
- fumadocs-core@16.2.1

16.2.0

Minor Changes

80579fd: No longer expose layout components

This includes Root Toggle, Language Toggle, Theme Toggle etc.

It allows Fumadocs UI to change these components without introducing breaking changes over existing customizations.

If you're using the removed components, consider overriding the layout components with yours, or use Fumadocs CLI add/customize command.
a9f4eda: Require importing page layout according to your docs layout
```
// for docs layout
import { DocsPage } from 'fumadocs-ui/layouts/docs/page';

// for notebook layout
import { DocsPage } from 'fumadocs-ui/layouts/notebook/page';
```
While the default fumadocs-ui/page will redirect to the correct layout, we highly recommend you to update the import.
5d65002: Remove container styles, this includes --spacing-fd-container as they are no longer used.
9a39883: Move Sidebar context into docs layouts

fumadocs-ui/contexts/sidebar is removed, you can still reference the context with:
```
import { useSidebar } from 'fumadocs-ui/components/sidebar/base';
```
Make sure you're only accessing it in <DocsLayout />.

Patch Changes

36eb90a: Fix sidebar items not automatically scrolled
12d3f78: Tabs: always prefer session storage
- fumadocs-core@16.2.0

16.1.0

Patch Changes

Updated dependencies [2e01720]
Updated dependencies [15bd183]
Updated dependencies [42ad84c]
- fumadocs-core@16.1.0

16.0.15

Patch Changes

40d9b75: Add 'idea' callout type
ade44d0: feat: enhance framework providers to accept custom Link components
Updated dependencies [fe380da]
Updated dependencies [ade44d0]
- fumadocs-core@16.0.15

16.0.14

Patch Changes

Updated dependencies [c3b8474]
- fumadocs-core@16.0.14

16.0.13

Patch Changes

88dae4d: Reduce px usage
- fumadocs-core@16.0.13

16.0.12

Patch Changes

Updated dependencies [c5c00e9]
- fumadocs-core@16.0.12

16.0.11

Patch Changes

00058c8: Drop framework-side createContext
Updated dependencies [ff68f69]
Updated dependencies [00058c8]
- fumadocs-core@16.0.11

16.0.10

Patch Changes

112e8d9: Support CalloutContainer, CalloutTitle and CalloutDescription components.

They're now MDX components included by default.
Updated dependencies [733b01e]
- fumadocs-core@16.0.10

16.0.9

Patch Changes

2eef888: Remove unnecessary aria-label from the link icon in headings
- fumadocs-core@16.0.9

16.0.8

Patch Changes

c0df2c4: improve navbar button gaps
117ad86: Add support for using a custom GitHub API base URL
Updated dependencies [bc97236]
Updated dependencies [ca09b6a]
Updated dependencies [117ad86]
- fumadocs-core@16.0.8

16.0.7

Patch Changes

Updated dependencies [f97cd1e]
Updated dependencies [f7e15e2]
- fumadocs-core@16.0.7

16.0.5

Patch Changes

Updated dependencies [8221785]
- fumadocs-core@16.0.5

16.0.4

Patch Changes

Updated dependencies [99971c7]
- fumadocs-core@16.0.4

16.0.3

Patch Changes

fumadocs-core@16.0.3

16.0.2

Patch Changes

Updated dependencies [d511232]
- fumadocs-core@16.0.2

16.0.1

Patch Changes

45f0c1f: hotfix <DynamicCodeBlock /> Vite + React 19.2 compat issues
Updated dependencies [45f0c1f]
- fumadocs-core@16.0.1

16.0.0

Major Changes

0ed0ca6: Change --fd-layout-width to 1600px by default

This will change the max layout width to 1600px, you can still change it back with:
```
:root {
  --fd-layout-width: 100vw;
}
```
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.

Patch Changes

1494340: Drop fumadocs-core/hide-if-empty usage, prefer user-side component overrides for precise control
de0ce6d: Add a toc-title ID to the table of contents heading for styling purposes
5966e23: Fix root toggle overflow
Updated dependencies [230c6bf]
Updated dependencies [851897c]
Updated dependencies [4049ccc]
Updated dependencies [429c41a]
Updated dependencies [5210f18]
Updated dependencies [cbc93e9]
Updated dependencies [42f09c3]
Updated dependencies [55afd8a]
- fumadocs-core@16.0.0

15.8.4

Patch Changes

Updated dependencies [ce2be59]
Updated dependencies [31b9494]
- fumadocs-core@15.8.4

15.8.3

Patch Changes

a3a14e7: Bump deps
7b0d839: Hotfix fumadocs-ui/provider
Updated dependencies [a3a14e7]
- fumadocs-core@15.8.3

15.8.2

Patch Changes

90cf1fe: Support tabMode on <DocsLayout />
6c3bde5: Prefer importing <RootProvider /> from fumadocs-ui/provider/<framework>
- Old fumadocs-ui/provider will be kept, as it's used by majority of previous projects.
- New guides & templates will follow the new recommendation.
Updated dependencies [ad9a004]
Updated dependencies [90cf1fe]
Updated dependencies [747bdbc]
- fumadocs-core@15.8.2

15.8.1

Patch Changes

Updated dependencies [71bce86]
Updated dependencies [f04547f]
- fumadocs-core@15.8.1

15.8.0

Patch Changes

53a0635: Support custom action type search item in search dialog
6548a59: Support breadcrumbs for Search API
Updated dependencies [655bb46]
Updated dependencies [d1ae3e8]
Updated dependencies [6548a59]
Updated dependencies [51268ec]
Updated dependencies [51268ec]
- fumadocs-core@15.8.0

15.7.13

Patch Changes

Updated dependencies [982aed6]
- fumadocs-core@15.7.13

15.7.12

Patch Changes

846b28a: Support multiple codeblocks in same tab
Updated dependencies [846b28a]
Updated dependencies [2b30315]
- fumadocs-core@15.7.12

15.7.11

Patch Changes

9304db9: Improve type table spacing
dd7338b: Fix inline code styles
- fumadocs-core@15.7.11

15.7.10

Patch Changes

Updated dependencies [c948f59]
- fumadocs-core@15.7.10

15.7.9

Patch Changes

45c7531: Type Table: Support displaying parameters & return types
4082acc: Redesign Type Table
Updated dependencies [d135efd]
Updated dependencies [4082acc]
- fumadocs-core@15.7.9

15.7.8

Patch Changes

ba3382f: Support link item properties in menu items
efba995: Enforce the use of --removed-body-scroll-bar-size to fixed elements
bec3b36: Use on-root: to apply CSS variables from child layout components
Updated dependencies [f65778d]
Updated dependencies [e4c12a3]
- fumadocs-core@15.7.8

15.7.7

Patch Changes

Updated dependencies [0b53056]
Updated dependencies [3490285]
- fumadocs-core@15.7.7

15.7.6

Patch Changes

dc6d8a0: unify sidebar tabs matching
- fumadocs-core@15.7.6

15.7.5

Patch Changes

cedc494: Hotfix URL normalization logic
Updated dependencies [cedc494]
- fumadocs-core@15.7.5

15.7.4

Patch Changes

302cdc2: Use position: fixed for TOC
02d3453: Make codeblocks flat & improve paddings
- fumadocs-core@15.7.4

15.7.3

Patch Changes

f6de900: Add overscroll to sidebar viewports
Updated dependencies [6d97379]
Updated dependencies [e776ee5]
- fumadocs-core@15.7.3

15.7.2

Patch Changes

Updated dependencies [88b5a4e]
Updated dependencies [039b24b]
Updated dependencies [08eee2b]
- fumadocs-core@15.7.2

15.7.1

Patch Changes

b4e6147: Fix sidebar & animation bugs
Updated dependencies [195b090]
Updated dependencies [e1c84a2]
- fumadocs-core@15.7.1

15.7.0

Minor Changes

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.

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

b109d06: Redesign useShiki & <DynamicCodeBlock /> to use React 19 hooks
b99cf51: Shadcn UI theme: support sidebar specific colors
Updated dependencies [514052e]
Updated dependencies [e254c65]
Updated dependencies [ec75601]
Updated dependencies [e785f98]
Updated dependencies [0531bf4]
Updated dependencies [50eb07f]
Updated dependencies [67df155]
Updated dependencies [b109d06]
- fumadocs-core@15.7.0

15.6.12

Patch Changes

fe31a72: Fix custom components auto RWD handling for home layout
- fumadocs-core@15.6.12

15.6.11

Patch Changes

6de6ff3: Restrict exports of layouts to avoid projects importing internal/unstable APIs
f0b1fee: Improve layout component customisation experience by handling RWD automatically
- fumadocs-core@15.6.11

15.6.10

Patch Changes

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.
Updated dependencies [569bc26]
Updated dependencies [817c237]
- fumadocs-core@15.6.10

15.6.9

Patch Changes

f2b22ca: simplify layout offset logic
Updated dependencies [0ab2cdd]
- fumadocs-core@15.6.9

15.6.8

Patch Changes

fumadocs-core@15.6.8

15.6.7

Patch Changes

e9fef34: Move sidebar toolbar to top on mobile view
d4a9037: improve codeblock diff styles
Updated dependencies [6fa1442]
- fumadocs-core@15.6.7

15.6.6

Patch Changes

2a0b45b: Change sidebar direction
5913cc4: Ignore IME composition to avoid accidental selection
79248f6: Improve type table link icon
Updated dependencies [1b0e9d5]
- fumadocs-core@15.6.6

15.6.5

Patch Changes

Updated dependencies [658fa96]
- fumadocs-core@15.6.5

15.6.4

Patch Changes

dca17d7: Improve search dialog consistency
- fumadocs-core@15.6.4

15.6.3

Patch Changes

a2d7940: Fix layout: remove reserved sidebar space when sidebar is disabled in DocsLayout
- fumadocs-core@15.6.3

15.6.2

Patch Changes

1e50889: Fix mobile sidebar trigger visibility when sidebar is disabled
353c139: Callout add fallback icons
5844c6f: no longer sort type table properties by default
- fumadocs-core@15.6.2

15.6.1

Patch Changes

Updated dependencies [1a902ff]
- fumadocs-core@15.6.1

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

bf15617: Fix Notebook layout minor UI inconsistency
Updated dependencies [d0f8a15]
Updated dependencies [84918b8]
Updated dependencies [f8d1709]
- fumadocs-core@15.6.0

15.5.5

Patch Changes

e9b1c9c: Support rainbowColors API in <Banner /> component
d5c9b11: Fix Notebook Layout tab mode navbar cannot handle nested tabs
Updated dependencies [0d3f76b]
- fumadocs-core@15.5.5

15.5.4

Patch Changes

4a1d3cf: Reduce sidebar intensity
58b7596: Fix copying line breaks with Twoslash codeblocks
Updated dependencies [35c3c0b]
- fumadocs-core@15.5.4

15.5.3

Patch Changes

Updated dependencies [7d1ac21]
- fumadocs-core@15.5.3

15.5.2

Patch Changes

b675728: Redesign search dialog style
1b7bc4b: Add @types/react to optional peer dependency to avoid version conflict in monorepos
82fc4c8: Avoid direct update to passed props.
Updated dependencies [7a45921]
Updated dependencies [1b7bc4b]
- fumadocs-core@15.5.2

15.5.1

Patch Changes

b4916d2: Move hide-if-empty component to Fumadocs Core
68526ea: Redesign fumadocs-ui/components/dialog/search usage to make it composable, and mark it as stable API.
Updated dependencies [b4916d2]
Updated dependencies [8738b9c]
Updated dependencies [a66886b]
- fumadocs-core@15.5.1

15.5.0

Minor Changes

589d101: Move TOC closer to page body on larger viewports

Changed layout positioning, all layout components now use fixed position.

This may impact sites that:
- using custom styling on Fumadocs layouts.
- added a custom footer (see below).
For custom footer, make sure to add them into <DocsLayout /> instead:
```
<DocsLayout>
  {children}
  <div className="h-[400px] bg-fd-secondary">Hello World</div>
</DocsLayout>
```

Patch Changes

50f8f7f: Update Home Layout navbar design
697d5b4: Support specifying a custom value for Accordion
- fumadocs-core@15.5.0

15.4.2

Patch Changes

Updated dependencies [0ab6c7f]
- fumadocs-core@15.4.2

15.4.1

Patch Changes

e72b7b4: hotfix: production source map being ignored
- fumadocs-core@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

092fd04: Fallback to dangerouslySetInnerHTML for inlined scripts for backward compatibility
7d78bc5: Improve createRelativeLink and getPageByHref for i18n usage
Updated dependencies [1b999eb]
Updated dependencies [961b67e]
Updated dependencies [7d78bc5]
- fumadocs-core@15.4.0

15.3.4

Patch Changes

e0c2a92: Improve UI consistency
71fc1a5: Mount all children of tabs by default
- fumadocs-core@15.3.4

15.3.3

Patch Changes

05b3bd9: [Internal] require TagsListItem to be used with TagsList
39bf088: Support usage with Tabs in primitive way
e955a98: Hotfix problems with HideIfEmpty
Updated dependencies [4ae7b4a]
- fumadocs-core@15.3.3

15.3.2

Patch Changes

1753cf1: Fix navbar external items and nav menu scroll
9b38baf: add success type to callout
8e862e5: Use native scroll bar for codeblocks and some elements for better performance
ac0ab12: Improve performance by reducing usage of @radix-ui/react-scroll-area
c25d678: Support Shiki focus notation transformer by default
Updated dependencies [c25d678]
- fumadocs-core@15.3.2

15.3.1

Patch Changes

3372792: Support line numbers in codeblock
Updated dependencies [3372792]
- fumadocs-core@15.3.1

15.3.0

Minor Changes

52b5ad8: Redesign mobile sidebar

Mobile sidebar is now a separate component from the desktop one, with its own id nd-sidebar-mobile.

note to advanced use cases: Fumadocs UI now stopped using fumadocs-core/sidebar, avoid using the primitive directly as provider is not used.

Patch Changes

abce713: Adjust design (Accordion, Tabs, border color of themes)
Updated dependencies [c05dc03]
- fumadocs-core@15.3.0

15.2.15

Patch Changes

50db874: Remove placeholder space for codeblocks
Updated dependencies [50db874]
Updated dependencies [79e75c3]
- fumadocs-core@15.2.15

15.2.14

Patch Changes

Updated dependencies [6ea1718]
- fumadocs-core@15.2.14

15.2.13

Patch Changes

b433d93: Recommend using custom button/link instead for edit on GitHub button
1e07ed8: Support disabling codeblock styles with .not-fumadocs-codeblock
- fumadocs-core@15.2.13

15.2.12

Patch Changes

b68bb51: Fix sidebar legacy behaviours
127e681: Fix Notebook layout ignores themeSwitch and sidebar.collapsible on nav mode
Updated dependencies [acff667]
- fumadocs-core@15.2.12

15.2.11

Patch Changes

d4d1ba7: Fix sidebar collapsible control search button still visible with search disabled
4e62b41: Bundle lucide-react as part of library
07cd690: Support separators without name
Updated dependencies [07cd690]
- fumadocs-core@15.2.11

15.2.10

Patch Changes

3a5595a: Support deprecated properties in Type Table
8c9fc1f: Fix callout margin
- fumadocs-core@15.2.10

15.2.9

Patch Changes

e72af4b: Improve layout
ea0f468: Fix relative file href with hash
7f3c30e: Add shadcn.css preset
- fumadocs-core@15.2.9

15.2.8

Patch Changes

4fad539: fix TOC relative position
a673ef4: Make @source in global.css optional
- fumadocs-core@15.2.8

15.2.7

Patch Changes

eb18da9: Support searchToggle option to customise search toggle
085e39f: Fix inline code issues
4d50bcf: fix banner overlapping with collapsible control
Updated dependencies [ec85a6c]
Updated dependencies [e1a61bf]
- fumadocs-core@15.2.7

15.2.6

Patch Changes

b07e98c: Deprecate DocsCategory, see https://fumadocs.vercel.app/docs/ui/markdown#further-reading-section
Updated dependencies [d49f9ae]
Updated dependencies [b07e98c]
Updated dependencies [3a4bd88]
- fumadocs-core@15.2.6

15.2.5

Patch Changes

Updated dependencies [c66ed79]
- fumadocs-core@15.2.5

15.2.4

Patch Changes

1057957: Fix type problems on dynamic codeblock
Updated dependencies [1057957]
- fumadocs-core@15.2.4

15.2.3

Patch Changes

5e4e9ec: Deprecate I18nProvider in favour of <RootProvider /> i18n prop
293178f: revert framework migration on i18n provider
- fumadocs-core@15.2.3

15.2.2

Patch Changes

0829544: Remove unused registry files from dist
Updated dependencies [0829544]
- fumadocs-core@15.2.2

15.2.1

Patch Changes

22aeafb: Improve Tree context performance
- fumadocs-core@15.2.1

15.2.0

Patch Changes

c5af09f: UI: Use text.previousPage for previous page navigation
Updated dependencies [2fd325c]
Updated dependencies [a7cf4fa]
- fumadocs-core@15.2.0

15.1.3

Patch Changes

Updated dependencies [b734f92]
- fumadocs-core@15.1.3

15.1.2

Patch Changes

44d5acf: Improve sidebar UI
Updated dependencies [3f580c4]
- fumadocs-core@15.1.2

15.1.1

Patch Changes

Updated dependencies [c5add28]
Updated dependencies [f3cde4f]
Updated dependencies [7c8a690]
Updated dependencies [b812457]
- fumadocs-core@15.1.1

15.1.0

Patch Changes

Updated dependencies [f491f6f]
Updated dependencies [f491f6f]
Updated dependencies [f491f6f]
- fumadocs-core@15.1.0

15.0.18

Patch Changes

e7e2a2a: Support createRelativeLink component factory for using relative file paths in href
- fumadocs-core@15.0.18

15.0.17

Patch Changes

b790699: Support themeSwitch option in layouts to customise theme switch
Updated dependencies [72f79cf]
- fumadocs-core@15.0.17

15.0.16

Patch Changes

fumadocs-core@15.0.16

15.0.15

Patch Changes

0e5e14d: Use container media queries on Cards
Updated dependencies [9f6d39a]
Updated dependencies [2035cb1]
- fumadocs-core@15.0.15

15.0.14

Patch Changes

6bc033a: Display humanized stars number to GitHub info component
Updated dependencies [37dc0a6]
Updated dependencies [796cc5e]
Updated dependencies [2cc0be5]
- fumadocs-core@15.0.14

15.0.13

Patch Changes

7608f4e: Support showing optional properties on TypeTable
89ff3ae: Support GithubInfo component
16c8944: Fix Tailwind CSS utilities
- fumadocs-core@15.0.13

15.0.12

Patch Changes

3534a10: Move fumadocs-core highlighting utils to fumadocs-core/highlight and fumadocs-core/highlight/client
ecacb53: Improve performance
Updated dependencies [3534a10]
Updated dependencies [93952db]
- fumadocs-core@15.0.12

15.0.11

Patch Changes

886da49: Fix sidebar layout shifts with defaultOpen option
04e6c6e: Fix Notebook layout paddings
- fumadocs-core@15.0.11

15.0.10

Patch Changes

e8a3ab7: Add collapse button back to sidebar on Notebook layout
Updated dependencies [d95c21f]
- fumadocs-core@15.0.10

15.0.9

Patch Changes

fa5b908: Fix React 18 compatibility
- fumadocs-core@15.0.9

15.0.8

Patch Changes

8f5993b: Support custom nav mode and tabs mode on Notebook layout
- fumadocs-core@15.0.8

15.0.7

Patch Changes

5deaf40: Support icons in separators of meta.json
f782c2c: Improve sidebar design
Updated dependencies [5deaf40]
- fumadocs-core@15.0.7

15.0.6

Patch Changes

Updated dependencies [08236e1]
Updated dependencies [a06af26]
- fumadocs-core@15.0.6

15.0.5

Patch Changes

14b2f95: Improve accessibility
- fumadocs-core@15.0.5

15.0.4

Patch Changes

c892bd9: Improve DocsCategory cards
c892bd9: Always show copy button on codeblocks on touch devices
- fumadocs-core@15.0.4

15.0.3

Patch Changes

47171db: UI: fix ocean theme
- fumadocs-core@15.0.3

15.0.2

Patch Changes

a8e9e1f: Bump deps
- fumadocs-core@15.0.2

15.0.1

Patch Changes

421166a: Fix border styles
- fumadocs-core@15.0.1

15.0.0

Major Changes

a84f37a: Migrate to Tailwind CSS v4

migrate:

Follow https://tailwindcss.com/blog/tailwindcss-v4 for official migrate guide of Tailwind CSS v4.

Fumadocs UI v15 redesigned the Tailwind CSS config to fully adhere the new config style, no JavaScript and options needed for plugins. Add the following to your CSS file:
```
@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
/* if you have Twoslash enabled */
@import 'fumadocs-twoslash/twoslash.css';

@source '../node_modules/fumadocs-ui/dist/**/*.js';
/* if you have OpenAPI enabled */
@source '../node_modules/fumadocs-openapi/dist/**/*.js';
```
The fumadocs-ui/css/preset.css import is required, it declares necessary plugins & styles for Fumadocs UI, and fumadocs-ui/css/neutral.css defines the color palette of UI.

Like the previous preset option in Tailwind CSS plugin, you can import other color presets like fumadocs-ui/css/vitepress.css.

You should also pay attention to @source, the file paths are relative to the CSS file itself. For your project, it might not be ../node_modules/fumadocs-ui/dist/**/*.js.

Patch Changes

a89d6e0: Support Fumadocs v15
f2f9c3d: Redesign sidebar
Updated dependencies [5b8cca8]
Updated dependencies [a763058]
Updated dependencies [581f4a5]
- fumadocs-core@15.0.0

14.7.7

Patch Changes

4f2538a: Support children prop in custom Folder component
191012a: DocsCategory search based on file path when item isn't present in the tree
fb6b168: No longer rely on search context on search dialog
- fumadocs-core@14.7.7

14.7.6

Patch Changes

Updated dependencies [b9601fb]
- fumadocs-core@14.7.6

14.7.5

Patch Changes

5d41bf1: Enable system option for theme toggle on NoteBook layout
900eb6c: Prevent shrink on sidebar icons by default
a959374: Support fd-* prefixes to Tailwind CSS utils
Updated dependencies [777188b]
- fumadocs-core@14.7.5

14.7.4

Patch Changes

26d9ccb: Fix banner preview
036f8e1: Disable hover to open navbar menu by default, can be enabled via nav.enableHoverToOpen
Updated dependencies [bb73a72]
Updated dependencies [69bd4fe]
- fumadocs-core@14.7.4

14.7.3

Patch Changes

041f230: Support trailing slash
ca1cf19: Support custom <Banner /> height
Updated dependencies [041f230]
- fumadocs-core@14.7.3

14.7.2

Patch Changes

Updated dependencies [14b280c]
- fumadocs-core@14.7.2

14.7.1

Patch Changes

18b00c1: Fix hideSearch option
Updated dependencies [72dc093]
- fumadocs-core@14.7.1

14.7.0

Patch Changes

a557bb4: revert contain
Updated dependencies [97ed36c]
- fumadocs-core@14.7.0

14.6.8

Patch Changes

e95be52: Fix i18n toggle
f3298ea: Add css prefix by default
- fumadocs-core@14.6.8

14.6.7

Patch Changes

Updated dependencies [5474343]
- fumadocs-core@14.6.7

14.6.6

Patch Changes

9c930ea: fix runtime error
- fumadocs-core@14.6.6

14.6.5

Patch Changes

969da26: Improve i18n api
Updated dependencies [969da26]
- fumadocs-core@14.6.5

14.6.4

Patch Changes

67124b1: Improve theme toggle on Notebook layout
1810868: Enable content-visibility CSS features
Updated dependencies [b71064a]
- fumadocs-core@14.6.4

14.6.3

Patch Changes

abc3677: Allow className to be used with SidebarItem
- fumadocs-core@14.6.3

14.6.2

Patch Changes

9908922: Add default icon styles (transformer) to sidebar tabs
ece734f: Support custom children of trigger on InlineTOC component
1a2597a: Expose --fd-tocnav-height CSS variable
Updated dependencies [2357d40]
- fumadocs-core@14.6.2

14.6.1

Patch Changes

9532855: Hide toc popover when no items
- fumadocs-core@14.6.1

14.6.0

Minor Changes

010da9e: Tabs: support usage without value
bebb16b: Support DynamicCodeBlock component

Patch Changes

9585561: Fix Twoslash popups focus outline
4766292: Support React 19
Updated dependencies [4dfde6b]
Updated dependencies [bebb16b]
Updated dependencies [4766292]
Updated dependencies [050b326]
- fumadocs-core@14.6.0

14.5.6

Patch Changes

b7745f4: Fix references problem of sidebar tabs
Updated dependencies [9a18c14]
- fumadocs-core@14.5.6

14.5.5

Patch Changes

06f66d8: improve notebook layout for transparent sidebar
2d0501f: Fi sidebar icon trigger
- fumadocs-core@14.5.5

14.5.4

Patch Changes

8e2cb31: fix trivial bugs
- fumadocs-core@14.5.4

14.5.3

Patch Changes

c5a5ba0: fix sidebar defaultOpenLevel
f34e895: Support props in tag items
4c82a3d: Hide toc when it has no items and custom banner & footer
f8e5157: Fix custom theme with Typography plugin
ad00dd3: Support folder groups on sidebar tabs
- fumadocs-core@14.5.3

14.5.2

Patch Changes

072e349: fix initial sidebar level to 0
- fumadocs-core@14.5.2

14.5.1

Patch Changes

6fd480f: Fix old browser compatibility
- fumadocs-core@14.5.1

14.5.0

Minor Changes

66c70ec: Replace official Tailwind CSS typography plugin
- Other variants like prose-sm and prose-gray are removed, as it's supposed to only provide support for Fumadocs UI typography styles.
05d224c: added the updateAnchor option for the Tabs ui component

Patch Changes

fumadocs-core@14.5.0

14.4.2

Patch Changes

0f1603a: Fix bugs
- fumadocs-core@14.4.2

14.4.1

Patch Changes

07474cb: fix codeblock paddings
48a2c15: Control page styles from layouts
- fumadocs-core@14.4.1

14.4.0

Minor Changes

5fd4e2f: Make TOC collapse to a popover on lg screen size instead of md
5fd4e2f: Support better table styles for Typography plugin
8a3f5b0: Make neutral the default theme of Fumadocs UI

Patch Changes

5145123: Fix sidebar footer issues
64defe0: Support fumadocs-ui/layouts/notebook layout
- fumadocs-core@14.4.0

14.3.1

Patch Changes

e7443d7: Fix development errors
- fumadocs-core@14.3.1

14.3.0

Minor Changes

b8a12ed: Move to tsc (experimental)

Patch Changes

80655b3: Improve padding of sidebar tabs and expose it to sidebar
- fumadocs-core@14.3.0

14.2.1

Patch Changes

2949da3: Show 'ctrl' for windows in search toggle
Updated dependencies [ca94bfd]
- fumadocs-core@14.2.1

14.2.0

Minor Changes

e248a0f: Support Orama Cloud integration
7a5393b: Replace cmdk with custom implementation

Patch Changes

Updated dependencies [e248a0f]
- fumadocs-core@14.2.0

14.1.1

Patch Changes

Updated dependencies [1573d63]
- fumadocs-core@14.1.1

14.0.1

Patch Changes

1a7d78a: Pass props to replaced layout components via Radix UI <Slot />
- fumadocs-core@14.0.1

14.0.0

Major Changes

d9e908e: Refactor import paths for layouts

migrate: Use

import { DocsLayout } from 'fumadocs-ui/layouts/docs';

import { HomeLayout } from 'fumadocs-ui/layouts/home';

import { BaseLayoutProps } from 'fumadocs-ui/layouts/shared';

Instead of

import { DocsLayout } from 'fumadocs-ui/layout';

import { HomeLayout } from 'fumadocs-ui/home-layout';

import { HomeLayoutProps } from 'fumadocs-ui/home-layout';

9a10262: Move Twoslash UI components to fumadocs-twoslash

why: Isolate logic from Fumadocs UI

migrate:

Before:

import 'fumadocs-ui/twoslash.css';

import { Popup } from 'fumadocs-ui/twoslash/popup';

After:

import 'fumadocs-twoslash/twoslash.css';

import { Popup } from 'fumadocs-twoslash/ui';

Tailwind CSS is now required for Twoslash integration.

d9e908e: Remove getImageMeta from fumadocs-ui/og

migrate: Use Metadata API from fumadocs-core/server
d9e908e: Replace fumadocs-core/search/shared with fumadocs-core/server
be53a0e: DocsCategory now accept from prop instead of pages prop.

why: This allows sharing the order of items with page tree. migrate:

The component now takes from prop which is the Source API object.
```
import { source } from '@/lib/source';
import { DocsCategory } from 'fumadocs-ui/page';

const page = source.getPage(params.slug);

<DocsCategory page={page} from={source} />;
```

Minor Changes

34cf456: Support disableThemeSwitch on layouts
d9e908e: Bundle icons into dist
ad47fd8: Show i18n language toggle on home layout
87063eb: Add root toggle to sidebar automatically
64f0653: Introduce --fd-nav-height CSS variable for custom navbar
e1ee822: Support hast nodes in toc variable
3d054a8: Support linking to a specific tab

Patch Changes

f949520: Support Shiki diff transformer
367f4c3: Improve Root Toggle component
d9e908e: Change default URL of title on i18n mode
d9e908e: Add center to root toggle
e612f2a: Make compatible with Next.js 15
3d0369a: Improve edit on GitHub button
be820c4: Bump deps
Updated dependencies [e45bc67]
Updated dependencies [d9e908e]
Updated dependencies [d9e908e]
Updated dependencies [f949520]
Updated dependencies [9a0b09f]
Updated dependencies [9a0b09f]
Updated dependencies [367f4c3]
Updated dependencies [e1ee822]
Updated dependencies [e612f2a]
Updated dependencies [9a0b09f]
Updated dependencies [d9e908e]
Updated dependencies [8ef00dc]
Updated dependencies [979e301]
Updated dependencies [d9e908e]
Updated dependencies [979e301]
Updated dependencies [15781f0]
Updated dependencies [be820c4]
Updated dependencies [d9e908e]
- fumadocs-core@14.0.0

13.4.10

Patch Changes

4cb74d5: Expose more props to Image Zoom
Updated dependencies [6231ad3]
- fumadocs-core@13.4.10

13.4.9

Patch Changes

bcf51a6: Improve banner rainbow variant
Updated dependencies [083f04a]
- fumadocs-core@13.4.9

13.4.8

Patch Changes

5581733: Add center to root toggle
1a327cc: Fix props types of Root Toggle
Updated dependencies [78e59e7]
- fumadocs-core@13.4.8

13.4.7

Patch Changes

6e1923e: Fix ocean present background repeat
6e1923e: Introduce rainbow variant on Banner component
Updated dependencies [6e1923e]
- fumadocs-core@13.4.7

13.4.6

Patch Changes

b33aff0: Fix typography styles
afb697e: Fix Next.js 14.2.8 dynamic import problems
6bcd263: Fix Banner component z-index
Updated dependencies [afb697e]
Updated dependencies [daa66d2]
- fumadocs-core@13.4.6

13.4.5

Patch Changes

d46a3f1: Improve search dialog
- fumadocs-core@13.4.5

13.4.4

Patch Changes

Updated dependencies [729928e]
- fumadocs-core@13.4.4

13.4.3

Patch Changes

fumadocs-core@13.4.3

13.4.2

Patch Changes

0c251e5: Bump deps
0c251e5: Support Shiki inline code
0c251e5: Improve nested list styles
Updated dependencies [7dabbc1]
Updated dependencies [0c251e5]
Updated dependencies [3b56170]
- fumadocs-core@13.4.2

13.4.1

Patch Changes

Updated dependencies [95dbba1]
- fumadocs-core@13.4.1

13.4.0

Minor Changes

26f5360: Support built-in OG Image generation

Patch Changes

fumadocs-core@13.4.0

13.3.3

Patch Changes

Updated dependencies [f8cc167]
- fumadocs-core@13.3.3

13.3.2

Patch Changes

17746a6: Support built-in edit on github button
Updated dependencies [0e0ef8c]
- fumadocs-core@13.3.2

13.3.1

Patch Changes

7258c4b: Fix thumb not rendered on initial render
- fumadocs-core@13.3.1

13.3.0

Minor Changes

8f5b19e: Introduce DocsTitle, DocsDescription and DocsCategory components
32ca37a: Support Clerk-style TOC
9aae448: Support multiple toc active items
c542561: Use cookie to store active locale on always mode

Patch Changes

Updated dependencies [4916f84]
Updated dependencies [fd46eb6]
Updated dependencies [fd46eb6]
Updated dependencies [fd46eb6]
Updated dependencies [fd46eb6]
Updated dependencies [9aae448]
Updated dependencies [c542561]
- fumadocs-core@13.3.0

13.2.2

Patch Changes

Updated dependencies [36b771b]
Updated dependencies [61b91fa]
- fumadocs-core@13.2.2

13.2.1

Patch Changes

Updated dependencies [17fa173]
- fumadocs-core@13.2.1

13.2.0

Minor Changes

ba588a2: Support custom max width
ec983a3: Change default value of defaultOpenLevel to 0

Patch Changes

96c9dda: Change Heading scroll margins
96c9dda: Hide TOC Popover on full mode
Updated dependencies [96c9dda]
- fumadocs-core@13.2.0

13.1.0

Minor Changes

c8910c4: Add default 'max-height' to codeblocks

Patch Changes

61ef42c: Add vitepress theme preset
deae4dd: Improve theme presets
c8910c4: Fix empty space on search dialog
6c42960: Improve TOC design
Updated dependencies [f280191]
- fumadocs-core@13.1.0

13.0.7

Patch Changes

e7c52f2: Fix code styles in headings
Updated dependencies [37bbfff]
- fumadocs-core@13.0.7

13.0.6

Patch Changes

1622e36: Fix bug breaking Tailwind CSS IntelliSense VSCode Extension
- fumadocs-core@13.0.6

13.0.5

Patch Changes

Updated dependencies [2cf65f6]
- fumadocs-core@13.0.5

13.0.4

Patch Changes

Updated dependencies [5355391]
- fumadocs-core@13.0.4

13.0.3

Patch Changes

Updated dependencies [978342f]
- fumadocs-core@13.0.3

13.0.2

Patch Changes

Updated dependencies [4819820]
- fumadocs-core@13.0.2

13.0.1

Patch Changes

fumadocs-core@13.0.1

13.0.0

Major Changes

89190ae: Rename prefix option on Tailwind CSS Plugin to cssPrefix

why: The previous name was misleading

migrate: Rename the option.

import { createPreset } from 'fumadocs-ui/tailwind-plugin';

/** @type {import('tailwindcss').Config} */
export default {
  presets: [
    createPreset({
      cssPrefix: 'fd',
    }),
  ],
};

b02eebf: Move keepCodeBlockBackground option to code block component

why: Easier to customise code block styles.

migrate:

Enable keepBackground on <CodeBlock />, and remove deprecated usage.

import { Pre, CodeBlock } from 'fumadocs-ui/components/codeblock';

<MDX
  components={{
    pre: ({ ref: _ref, ...props }) => (
      <CodeBlock keepBackground {...props}>
        <Pre>{props.children}</Pre>
      </CodeBlock>
    ),
  }}
/>;

f868018: Replace secondary link items with icon link items

why: Link items with type secondary has been deprecated long time ago.

migrate: Replace type secondary with icon.

8aebeab: Change usage of I18nProvider

why: Make possible to load translations lazily

migrate:

import { RootProvider } from 'fumadocs-ui/provider';
import type { ReactNode } from 'react';
import { I18nProvider } from 'fumadocs-ui/i18n';

export default function Layout({
  params: { lang },
  children,
}: {
  params: { lang: string };
  children: ReactNode;
}) {
  return (
    <html lang={lang}>
      <body>
        <I18nProvider
          locale={lang}
          // options
          locales={[
            {
              name: 'English',
              locale: 'en',
            },
            {
              name: 'Chinese',
              locale: 'cn',
            },
          ]}
          // translations
          translations={
            {
              cn: {
                toc: '目錄',
                search: '搜尋文檔',
                lastUpdate: '最後更新於',
                searchNoResult: '沒有結果',
                previousPage: '上一頁',
                nextPage: '下一頁',
              },
            }[lang]
          }
        >
          <RootProvider>{children}</RootProvider>
        </I18nProvider>
      </body>
    </html>
  );
}

8aebeab: Require locale prop on I18nProvider

why: Fix problems related to pathname parsing

migrate: Pass locale parameter to the provider
0377bb4: Rename id prop on Tabs component to groupId

why: Conflicted with HTML id attribute.

migrate: Rename to groupId.
e8e6a17: Make Tailwind CSS Plugin ESM-only

why: Tailwind CSS supported ESM and TypeScript configs.

migrate: Use ESM syntax in your Tailwind CSS config.
c901e6b: Remove deprecated fumadocs-ui/components/api components

why: The new OpenAPI integration has its own UI implementation.

migrate: Update to latest OpenAPI integration.
89190ae: Add fd- prefix to all Fumadocs UI colors, animations and utilities

why: The added Tailwind CSS colors may conflict with the existing colors of codebases.

migrate: Enable addGlobalColors on Tailwind CSS Plugin or add the fd- prefix to class names.
```
import { createPreset } from 'fumadocs-ui/tailwind-plugin';

/** @type {import('tailwindcss').Config} */
export default {
  presets: [
    createPreset({
      addGlobalColors: true,
    }),
  ],
};
```
b02eebf: Change code block component usage

why: The previous usage was confusing, some props are passed directly to pre while some are not.

migrate:

Pass all props to CodeBlock component. This also includes class names, change your custom styles if necessary.
```
import { Pre, CodeBlock } from 'fumadocs-ui/components/codeblock';

<MDX
  components={{
    // HTML `ref` attribute conflicts with `forwardRef`
    pre: ({ ref: _ref, ...props }) => (
      <CodeBlock {...props}>
        <Pre>{props.children}</Pre>
      </CodeBlock>
    ),
  }}
/>;
```
You can ignore this if you didn't customise the default pre element.
4373231: Remove RollButton component

why: RollButton was created because there were no "Table Of Contents" on mobile viewports. Now users can use the TOC Popover to switch between headings, RollButton is no longer a suitable design for Fumadocs UI.

migrate: Remove usages, you may copy the last implementation of RollButton.

Minor Changes

c684c00: Support to disable container style overriding
c8964d3: Include Callout as default MDX component

Patch Changes

daa7d3c: Fix empty folder animation problems
Updated dependencies [09c3103]
Updated dependencies [c714eaa]
Updated dependencies [b02eebf]
- fumadocs-core@13.0.0

12.5.6

Patch Changes

a332bee: Support undefined state of defaultOpen in folder nodes
- fumadocs-core@12.5.6

12.5.5

Patch Changes

3519e6c: Fix TOC overflow problems
- fumadocs-core@12.5.5

12.5.4

Patch Changes

fccdfdb: Improve TOC Popover design
Updated dependencies [fccdfdb]
Updated dependencies [2ffd5ea]
- fumadocs-core@12.5.4

12.5.3

Patch Changes

5d963f4: Support to disable prefetching links on sidebar
- fumadocs-core@12.5.3

12.5.2

Patch Changes

a5c34f0: Support specifying the url of root node when breadcrumbs have includeRoot enabled
Updated dependencies [a5c34f0]
- fumadocs-core@12.5.2

12.5.1

Patch Changes

c5d20d0: Fix wrong padding
3d8f6cf: Add data attributes to certain components to improve CSS targeting
- fumadocs-core@12.5.1

12.5.0

Minor Changes

b9fa99d: Support tag filters in search dialog
a4bcaa7: Rename Layout in fumadocs-ui/layout to HomeLayout in fumadocs-ui/home-layout

Patch Changes

d1c7405: Optimize performance
Updated dependencies [b9fa99d]
Updated dependencies [525925b]
- fumadocs-core@12.5.0

12.4.2

Patch Changes

503e8e9: Improve Object Collaspible
Updated dependencies [503e8e9]
- fumadocs-core@12.4.2

12.4.1

Patch Changes

fumadocs-core@12.4.1

12.4.0

Minor Changes

eb36761: Replace link item secondary type with icon (backward compatible)
eb36761: Support secondary property in link items
eb36761: Support button type link item
eb36761: Support on filter in link items

Patch Changes

33ffa99: Improve design details
- fumadocs-core@12.4.0

12.3.6

Patch Changes

4cc5782: Adding secondary custom links
- fumadocs-core@12.3.6

12.3.5

Patch Changes

fumadocs-core@12.3.5

12.3.4

Patch Changes

fbfd050: Improve the default theme
eefa75d: Reduce the navbar height
- fumadocs-core@12.3.4

12.3.3

Patch Changes

90d51cb: Fix problem with I18n middleware & language toggle
Updated dependencies [90d51cb]
- fumadocs-core@12.3.3

12.3.2

Patch Changes

Updated dependencies [ca7d0f4]
- fumadocs-core@12.3.2

12.3.1

Patch Changes

Updated dependencies [cf852f6]
- fumadocs-core@12.3.1

12.3.0

Patch Changes

Updated dependencies [ce3c8ad]
Updated dependencies [ce3c8ad]
- fumadocs-core@12.3.0

12.2.5

Patch Changes

7c23f7e: No longer set a default size for SVG elements in title
- fumadocs-core@12.2.5

12.2.4

Patch Changes

ffb9026: Fix cmdk upstream dependency problems
- fumadocs-core@12.2.4

12.2.3

Patch Changes

b4824fa: Updated <APIInfo /> component, so method name appears vertically centered.
e120e0f: Improve <Banner/> component
3970b55: Support custom type link items
- fumadocs-core@12.2.3

12.2.2

Patch Changes

72c7991: Improve sidebar
- fumadocs-core@12.2.2

12.2.1

Patch Changes

c428a60: Revert the height of docs navbar to 64px
018dbd9: Support Banner component
- fumadocs-core@12.2.1

12.2.0

Minor Changes

318eaf9: Redesign TOC popover: Make the TOC Popover trigger a part of navbar.
ea22d04: Improve dynamic sidebar: Improve animation & close delay

Patch Changes

2f2d9cf: Improve footer: Use card-style buttons to match the other buttons
bcc9f91: Added a new colors for API info badge, so POST, PATCH requests are different from PUT.
2f2d9cf: Improve OpenAPI styles
Updated dependencies [b70ff06]
- fumadocs-core@12.2.0

12.1.3

Patch Changes

2a5db91: Add timeout for hovering after collapsed the sidebar
3e98d7d: Support full mode on pages
d06c92a: Support transparentMode on secondary (docs) navbar
3bdc786: Support Fumadocs OpenAPI 3.1.0
d06c92a: Fix hot keys order
- fumadocs-core@12.1.3

12.1.2

Patch Changes

284a571: Support Fumadocs OpenAPI v3
Updated dependencies [b4856d1]
- fumadocs-core@12.1.2

12.1.1

Patch Changes

1c3a127: Redesign Tabs component
Updated dependencies [a39dbcb]
- fumadocs-core@12.1.1

12.1.0

Minor Changes

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.

Patch Changes

0a377a9: Close sidebar on collapse
5f86faa: Improve multi-line code blocks
Updated dependencies [0a377a9]
Updated dependencies [0a377a9]
- fumadocs-core@12.1.0

12.0.7

Patch Changes

51441d3: Fix RollButton component problems on Safari
- fumadocs-core@12.0.7

12.0.6

Patch Changes

056bad5: Improve default values
Updated dependencies [7a29b79]
Updated dependencies [b0c1242]
- fumadocs-core@12.0.6

12.0.5

Patch Changes

4455d58: Fix bannerProps being ignored
- fumadocs-core@12.0.5

12.0.4

Patch Changes

70666d8: Hide file name on breadcrumbs
f96da27: Improve design details
51ca944: Support including separators in breadcrumbs
Updated dependencies [72dbaf1]
Updated dependencies [51ca944]
- fumadocs-core@12.0.4

12.0.3

Patch Changes

18928af: Improve mobile experience on Safari
Updated dependencies [053609d]
- fumadocs-core@12.0.3

12.0.2

Patch Changes

Show TOC on mobile devices
- fumadocs-core@12.0.2

12.0.1

Patch Changes

21fe244: Redesign roll button
547a61a: Use Menu for link items
- fumadocs-core@12.0.1

12.0.0

Major Changes

62b5abb: New Layout
- Remove navbar from docs layout, replace it with sidebar.
- On smaller devices, navbar is always shown.
- Remove exports of internal components, copying components from the repository is now the preferred way.
migrate: On layouts, Rename nav.githubUrl to githubUrl. Modify your stylesheet if necessary.
5741224: Remove deprecated option enableThemeProvider from Root Provider

migrate: Use theme.enabled instead.

2f8b168: Replace <LanguageSelect /> component with <LanguageToggle />

migrate:

Remove your <LanguageSelect /> component from the layout. Enable the new language toggle with:

import { DocsLayout } from 'fumadocs-ui/layout';

export default function Layout({ children }: { children: React.ReactNode }) {
  return <DocsLayout i18n>{children}</DocsLayout>;
}

Minor Changes

d88dfa6: Support switching between page trees with RootToggle component

Patch Changes

c110040: Fix problems with twoslash codeblocks
13a60b9: Heading support typography styles
1fe0812: Support translation for theme label
Updated dependencies [98430e9]
Updated dependencies [d88dfa6]
Updated dependencies [ba20694]
Updated dependencies [57eb762]
- fumadocs-core@12.0.0

11.3.2

Patch Changes

1b8e12b: Use display: grid for codeblocks
Updated dependencies [1b8e12b]
- fumadocs-core@11.3.2

11.3.1

Patch Changes

10ab3e9: Fix sidebar opened by default
- fumadocs-core@11.3.1

11.3.0

Minor Changes

917d87f: Rename sidebar primitive minWidth prop to blockScrollingWidth

Patch Changes

2a1211e: Support customising search dialog hotkeys
9de31e6: Support withArticle for MDX Pages
Updated dependencies [917d87f]
- fumadocs-core@11.3.0

11.2.2

Patch Changes

dd0feb2: Support customising sidebar background with opacity
72096c3: Support customising theme options from root provider
- fumadocs-core@11.2.2

11.2.1

Patch Changes

8074920: Fix sidebar background width on dynamic sidebar
- fumadocs-core@11.2.1

11.2.0

Minor Changes

3292df1: Support sliding dynamic sidebar

Patch Changes

fumadocs-core@11.2.0

11.1.3

Patch Changes

2b95c89: Fix codeblock select highlight problems
cdc52ad: Improve page footer mobile responsibility
Updated dependencies [88008b1]
Updated dependencies [944541a]
Updated dependencies [07a9312]
- fumadocs-core@11.1.3

11.1.2

Patch Changes

58adab1: Improve theme & styles
ae88793: Improve page footer design
- fumadocs-core@11.1.2

11.1.1

Patch Changes

771314c: Use sessionStorage for non-persistent tabs
8ef2b68: Bump deps
fa78241: Fix accordion text alignment
Updated dependencies [8ef2b68]
Updated dependencies [26f464d]
Updated dependencies [26f464d]
- fumadocs-core@11.1.1

11.1.0

Minor Changes

02a014f: Support custom menu items in navbar

Patch Changes

fumadocs-core@11.1.0

11.0.8

Patch Changes

Updated dependencies [98258b5]
- fumadocs-core@11.0.8

11.0.7

Patch Changes

Updated dependencies [f7c2c5c]
- fumadocs-core@11.0.7

11.0.6

Patch Changes

8e0ef4b: Support disable search functionality including shortcuts
Updated dependencies [5653d5d]
Updated dependencies [5653d5d]
- fumadocs-core@11.0.6

11.0.5

Patch Changes

c8ea344: Support disabling search bar
- fumadocs-core@11.0.5

11.0.4

Patch Changes

7b61b2f: Migrate fumadocs-ui to fully ESM, adding support for ESM tailwind.config file
Updated dependencies [7b61b2f]
- fumadocs-core@11.0.4

11.0.3

Patch Changes

c11e6ce: New color preset: catppuccin
- fumadocs-core@11.0.3

11.0.2

Patch Changes

6470d6d: Fix collapse button on smaller viewports
- fumadocs-core@11.0.2

11.0.1

Patch Changes

1136e02: Support modifying css with color presets
1136e02: New color preset neutral
f6b4797: Improve Sidebar footer
- fumadocs-core@11.0.1

11.0.0

Major Changes

2d8df75: Replace nav.links option with secondary links

why: A more straightforward API design

migrate:

<DocsLayout
+  links={[
+    {
+      type: 'secondary',
+      text: 'Github',
+      url: 'https://github.com',
+      icon: <GithubIcon />,
+      external: true,
+    },
+  ]}
-  nav={{
-    links: [
-      {
-        icon: <GithubIcon />,
-        href: 'https://github.com',
-        label: 'Github',
-        external: true,
-      },
-    ],
-  }}
>
  {children}
</DocsLayout>

Patch Changes

Updated dependencies [2d8df75]
Updated dependencies [92cb12f]
Updated dependencies [f75287d]
Updated dependencies [2d8df75]
- fumadocs-core@11.0.0

10.1.3

Patch Changes

6ace206: Support opening Twoslash popup on mobile
d0288d1: New theme dusk
Updated dependencies [bbad52f]
- fumadocs-core@10.1.3

10.1.2

Patch Changes

0facc07: Replace navbar links with secondary links
fd38022: Improve sidebar collapse
- fumadocs-core@10.1.2

10.1.1

Patch Changes

38d6f22: Improve RTL Layout experience
Updated dependencies [779c599]
Updated dependencies [0c01300]
Updated dependencies [779c599]
- fumadocs-core@10.1.1

10.1.0

Minor Changes

566539a: Support RTL layout

Patch Changes

fumadocs-core@10.1.0

10.0.5

Patch Changes

Updated dependencies [e47c62f]
- fumadocs-core@10.0.5

10.0.4

Patch Changes

fumadocs-core@10.0.4

10.0.3

Patch Changes

b27091f: Support passing search dialog options from root provider
Updated dependencies [6f321e5]
- fumadocs-core@10.0.3

10.0.2

Patch Changes

10e099a: Add scrollbar to TOC
Updated dependencies [10e099a]
- fumadocs-core@10.0.2

10.0.1

Patch Changes

0e78dc8: Support customising search API URL
Updated dependencies [c9b7763]
Updated dependencies [0e78dc8]
Updated dependencies [d8483a8]
- fumadocs-core@10.0.1

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"

Patch Changes

de7ed150: Hide external items from navigation footer
Updated dependencies [b5d16938]
Updated dependencies [321d1e1f]
- fumadocs-core@10.0.0

9.1.0

Minor Changes

ffc76e9d: Support to override sidebar components
1c388ca5: Support defaultOpen for folder nodes

Patch Changes

Updated dependencies [909b0e35]
Updated dependencies [691f12aa]
Updated dependencies [1c388ca5]
- fumadocs-core@9.1.0

9.0.0

Major Changes

071898da: Remove deprecated usage of Files component

Why: Since 8.3.0, you should use the Folder component instead for folders. For simplicity, the title prop has been renamed to name.

Migrate: Replace folders with the Folder component. Rename title prop to name.
```
- <Files>
- <File title="folder">
- <File title="file.txt" />
- </File>
- </Files>

+ <Files>
+ <Folder name="folder">
+ <File name="file.txt" />
+ </Folder>
+ </Files>
```
2b355907: Remove controlled usage for Accordion

Why: Components in Fumadocs UI should not be used outside of MDX.

Migrate: Remove value and onValueChange props.

Patch Changes

fumadocs-core@9.0.0

8.3.0

Minor Changes

b0003d44: Add purple theme
9bdb49dd: Add Folder export to fumadocs-ui/components/files
99d66d2d: Rename title prop to name in File and Folder component

Patch Changes

5e314eee: Deprecate input color and medium font size from Tailwind CSS preset
52d578d0: Set darkMode to class by default
84667d2f: Improve Accordions
- fumadocs-core@8.3.0

8.2.0

Minor Changes

5c24659: Support code block icons

Patch Changes

09bdf63: Separate stylesheet with Image Zoom component
Updated dependencies [5c24659]
- fumadocs-core@8.2.0

8.1.1

Patch Changes

153ceaf: Fix typo
- fumadocs-core@8.1.1

8.1.0

Minor Changes

0012eba: Support Typescript Twoslash
bc936c5: Add AutoTypeTable server component

Patch Changes

6c5a39a: Rename Git repository to fumadocs
Updated dependencies [6c5a39a]
Updated dependencies [eb028b4]
Updated dependencies [054ec60]
- fumadocs-core@8.1.0

8.0.0

Major Changes

a2f4819: Improve internationalized routing

I18nProvider now handles routing for you. Therefore, locale and onChange is no longer required.
```
<I18nProvider
  translations={{
    cn: {
      name: 'Chinese', // required
      search: 'Translated Content',
    },
  }}
></I18nProvider>
```
LanguageSelect detects available options from your translations, therefore, the languages prop is removed.

c608ad2: Remove deprecated docsUiPlugins

migrate: Use createPreset instead

const { createPreset } = require('fumadocs-ui/tailwind-plugin');

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    './components/**/*.{ts,tsx}',
    './app/**/*.{ts,tsx}',
    './content/**/*.mdx',
    './node_modules/fumadocs-ui/dist/**/*.js',
  ],
  presets: [createPreset()],
};

2ea9437: Change usage of Code Block component

The inner pre element is now separated from code block container, making it easier to customise.`

Before:

import { CodeBlock, Pre } from 'fumadocs-ui/mdx/pre';

<Pre title={title} allowCopy {...props} />;

After:

import { CodeBlock, Pre } from 'fumadocs-ui/components/codeblock';

<CodeBlock title={title} allowCopy>
  <Pre {...props} />
</CodeBlock>;

ac424ec: Update import paths of MDX components

why: To improve consistency, all MDX components are located in /components/* instead.

migrate:

- import { Card, Cards } from "fumadocs-ui/mdx/card"
+ import { Card, Cards } from "fumadocs-ui/components/card"

- import { Heading } from "fumadocs-ui/mdx/heading"
+ import { Heading } from "fumadocs-ui/components/heading"

- import { Codeblock, Pre } from "fumadocs-ui/mdx/pre"
+ import { Codeblock, Pre } from "fumadocs-ui/components/codeblock"

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
60db195: Remove Nav component export

why: Replaced by the DocsLayout and Layout component, it is now an internal component

migration: Use the Layout component for sharing the navbar across pages
```
- import { Nav } from "fumadocs-ui/nav"
+ import { Layout } from "fumadocs-ui/layout"
```

Minor Changes

60db195: Support transparent navbar

Patch Changes

974e00f: Collapse API example by default