Changelog

The latest releases of Fumadocs.

February 2024

Feb 18
fumadocs-mdx@8.0.4
Patch Changes
- fumadocs-core@8.3.0
Feb 18
create-fumadocs-app@8.3.0
Feb 18
fumadocs-core@8.3.0
Feb 18
fumadocs-contentlayer@1.0.5
Patch Changes
- fumadocs-core@8.3.0
Feb 11
fumadocs-mdx@8.0.3
Patch Changes
- 9bf5adb: Replace await imports with normal imports
- Updated dependencies [5c24659]
  - fumadocs-core@8.2.0
Feb 11
fumadocs-ui@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
Feb 11
fumadocs-twoslash@1.0.2
Patch Changes
- 08e4904: Update types
Feb 11
fumadocs-core@8.2.0
Minor Changes
- 5c24659: Support code block icons
Feb 11
fumadocs-openapi@1.1.0
Minor Changes
- 8665888: Added patterns support to config Inputs.
Feb 11
create-fumadocs-app@8.2.0
Feb 11
fumadocs-contentlayer@1.0.4
Patch Changes
- Updated dependencies [5c24659]
  - fumadocs-core@8.2.0
Feb 1
fumadocs-twoslash@1.0.1
Patch Changes
- c71b7e3: Ignore injected elements when copying code

January 2024

Jan 31
fumadocs-mdx@8.0.2
Patch Changes
- fumadocs-core@8.1.1
Jan 31
fumadocs-ui@8.1.1
Patch Changes
- 153ceaf: Fix typo
  - fumadocs-core@8.1.1
Jan 31
create-fumadocs-app@8.1.1
Jan 31
fumadocs-core@8.1.1
Jan 31
fumadocs-contentlayer@1.0.3
Patch Changes
- fumadocs-core@8.1.1
Jan 30
fumadocs-ui@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
Jan 30
fumadocs-openapi@1.0.1
Patch Changes
- 6c5a39a: Rename Git repository to fumadocs
Jan 30
fumadocs-mdx@8.0.1
Patch Changes
- 6c5a39a: Rename Git repository to fumadocs
- Updated dependencies [6c5a39a]
- Updated dependencies [eb028b4]
- Updated dependencies [054ec60]
  - fumadocs-core@8.1.0
Jan 30
create-fumadocs-app@8.1.0
Patch Changes
- 6c5a39a: Rename Git repository to fumadocs
Jan 30
fumadocs-contentlayer@1.0.2
Patch Changes
- 6c5a39a: Rename Git repository to fumadocs
- Updated dependencies [6c5a39a]
- Updated dependencies [eb028b4]
- Updated dependencies [054ec60]
  - fumadocs-core@8.1.0
Jan 30
fumadocs-core@8.1.0
Minor Changes
- eb028b4: Migrate to shiki
- 054ec60: Support generating docs for Typescript file
Patch Changes
- 6c5a39a: Rename Git repository to fumadocs
Jan 26
fumadocs-contentlayer@1.0.1
Patch Changes
- Updated dependencies [2b11c20]
  - fumadocs-core@8.0.0

Jan 26

fumadocs-ui@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

Jan 26
fumadocs-openapi@1.0.0
Major Changes
- 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
Jan 26
fumadocs-mdx@8.0.0
Major Changes
- 1a346a1: Enable remark-image plugin by default
  
  You can add image embeds easily. They will be converted to static image imports.
  ![banner](/image.png)
  Become:
  import img_banner from '../../public/image.png'; <img alt="banner" src={img_banner} />
- 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
Jan 26
create-fumadocs-app@8.0.0
Major Changes
- 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
Jan 26
fumadocs-core@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 const config = 'Hello'; 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)
Jan 17
next-docs-zeta@7.1.2