Changelog

The latest releases of Fumadocs.

January 2024

Jan 17
next-docs-ui@7.1.2
Patch Changes
- 9204975: Fix search dialog overflow issues
  - next-docs-zeta@7.1.2
Jan 17
next-docs-mdx@7.1.2
Patch Changes
- next-docs-zeta@7.1.2
Jan 17
create-next-docs-app@7.1.2
Patch Changes
- b836055: Remove deprecated usage from templates
Jan 16
next-docs-zeta@7.1.1
Jan 16
next-docs-ui@7.1.1
Patch Changes
- next-docs-zeta@7.1.1
Jan 16
next-docs-mdx@7.1.1
Patch Changes
- next-docs-zeta@7.1.1
Jan 16
create-next-docs-app@7.1.1
Patch Changes
- 65f71d4: Fix picocolors import errors
Jan 15
next-docs-ui@7.1.0
Minor Changes
- 40e51a4: Support integration with @fuma-docs/openapi
- d2744a4: Remove tailwindcss-animate
Patch Changes
- c527044: Support preloading Search Dialog
  - next-docs-zeta@7.1.0

Jan 15

@fuma-docs/openapi@0.1.0

Minor Changes

45a52ae: Support generating docs for OpenAPI schema

In openapi.config.js:

/**
 * @type {import("@fuma-docs/openapi").Config}
 */
module.exports = {
  input: ['./petstore.yaml'],
  output: './content/docs',
  per: 'tag',
  render: (title, description) => {
    return {
      frontmatter: [
        '---',
        `title: ${title}`,
        `description: ${description}`,
        'toc: false',
        '---',
      ].join('\n'),
    };
  },
};

Run fuma-docs-openapi to generate.

Jan 15
next-docs-mdx@7.1.0
Patch Changes
- next-docs-zeta@7.1.0
Jan 15
next-docs-zeta@7.1.0
Jan 15
create-next-docs-app@7.1.0
Jan 5
next-docs-ui@7.0.0
Major Changes
- f995ad9: Page Footer is now a client component
  
  This allows the footer component to find items within the current page tree, which fixes the problem where a item from another page tree is appeared.
  
  Also removed the url and tree properties from DocsPage since we can pass them via React Context API.
  export default async function Page({ params }) { return ( <DocsPage - url={page.url} - tree={pageTree} > ... </DocsPage> ); }
  The footer property in DocsPage has also updated, now you can specify or replace the default footer component.
  <DocsPage footer={{ items: {} }}>...</DocsPage>
Minor Changes
- b30d1cd: Support theme presets
  
  Add theme presets for the Tailwind CSS plugin, the default and ocean presets are available now.
  const { docsUi, docsUiPlugins } = require('next-docs-ui/tailwind-plugin'); /** @type {import('tailwindcss').Config} */ module.exports = { plugins: [ ...docsUiPlugins, docsUi({ preset: 'ocean', }), ], };
- 9929c5b: Support multiple page tree roots
  
  You can specify a root property in meta.json, the nearest root folder will be used as the root of page tree instead.
  { "title": "Hello World", "root": true }
Patch Changes
- Updated dependencies [9929c5b]
- Updated dependencies [9929c5b]
- Updated dependencies [49201be]
- Updated dependencies [338ea98]
- Updated dependencies [4c1334e]
- Updated dependencies [9929c5b]
  - next-docs-zeta@7.0.0
Jan 5
next-docs-zeta@7.0.0
Major Changes
- 9929c5b: Migrate Contentlayer Integration to Source API
  
  createContentlayer is now replaced by createContentlayerSource.
  
  You should configure base URL and root directory in the loader instead of Contentlayer configuration.
  
  It's no longer encouraged to access allDocs directly because they will not include url property anymore. Please consider getPages instead.
  import { allDocs, allMeta } from 'contentlayer/generated'; import { createContentlayerSource } from 'next-docs-zeta/contentlayer'; import { loader } from 'next-docs-zeta/source'; export const { getPage, pageTree, getPages } = loader({ baseUrl: '/docs', rootDir: 'docs', source: createContentlayerSource(allMeta, allDocs), });
  The interface is very similar, but you can only access Contentlayer properties from page.data.
  - <Content code={page.body.code} /> + <Content code={page.data.body.code} />
- 9929c5b: Source API
  
  To reduce boilerplate, the Source API is now released to handle File-system based files.
  
  Thanks to this, you don't have to deal with the inconsistent behaviours between different content sources anymore.
  
  The interface is now unified, you can easily plug in a content source.
  import { map } from '@/.map'; import { createMDXSource } from 'next-docs-mdx'; import { loader } from 'next-docs-zeta/source'; export const { getPage, getPages, pageTree } = loader({ baseUrl: '/docs', rootDir: 'docs', source: createMDXSource(map), });
  Page Tree Builder API is removed in favor of this
- 49201be: Change remarkToc to remarkHeading
  
  The previous remarkToc plugin only extracts table of contents from documents, now it also adds the id property to all heading elements.
  - import { remarkToc } from "next-docs-zeta/mdx-plugins" + import { remarkHeading } from "next-docs-zeta/mdx-plugins"
- 4c1334e: Improve createI18nMiddleware function
  
  Now, you can export the middleware directly without a wrapper.
  
  From:
  export default function middleware(request: NextRequest) { return createI18nMiddleware(...); }
  To:
  export default createI18nMiddleware({ defaultLanguage, languages, });
Minor Changes
- 338ea98: Export create function for Contentlayer configuration
  
  If you want to include other document types, or override the output configuration, the create function can return the fields and document types you need.
  import { create } from 'next-docs-zeta/contentlayer/configuration'; const config = create(options); export default { contentDirPath: config.contentDirPath, documentTypes: [config.Docs, config.Meta], mdx: config.mdx, };
- 9929c5b: Support multiple page tree roots
  
  You can specify a root property in meta.json, the nearest root folder will be used as the root of page tree instead.
  { "title": "Hello World", "root": true }
Jan 5
next-docs-mdx@7.0.0
Major Changes
- 9929c5b: Prefer .map.ts instead of _map.ts
  
  Unless you have especially configured, now it uses .map.ts by default.
  - import map from "@/_map" + import map from "@/.map"
- 9929c5b: Migrate to Source API
  
  fromMap has been removed. Please use createMDXSource instead.
  import { map } from '@/.map'; import { createMDXSource } from 'next-docs-mdx'; import { loader } from 'next-docs-zeta/source'; export const { getPage, getPages, pageTree } = loader({ baseUrl: '/docs', rootDir: 'docs', source: createMDXSource(map), });
Minor Changes
- 8fd769f: Support last modified timestamp for Git
  
  Enable this in next.config.mjs:
  const withNextDocs = createNextDocs({ mdxOptions: { lastModifiedTime: 'git', }, });
  Access it via page.data.exports.lastModified.
Patch Changes
- Updated dependencies [9929c5b]
- Updated dependencies [9929c5b]
- Updated dependencies [49201be]
- Updated dependencies [338ea98]
- Updated dependencies [4c1334e]
- Updated dependencies [9929c5b]
  - next-docs-zeta@7.0.0
Jan 5
create-next-docs-app@7.0.0
Major Changes
- 579ecaa: Support template for Tailwind CSS + Next Docs MDX

December 2023

Dec 18
next-docs-ui@6.1.0
Minor Changes
- 6e0d2e1: Support Layout for non-docs pages (without page tree)
  
  Same as Docs Layout but doesn't include a sidebar. It can be used outside of the docs, a page tree is not required.
  import { Layout } from 'next-docs-ui/layout'; export default function HomeLayout({ children }) { return <Layout>{children}</Layout>; }
  nav.items prop is deprecated
  
  It is now replaced by links.
- 2a82e9d: Support linking to accordions
  
  You can now specify an id for accordion. The accordion will automatically open when the user is navigating to the page with the specified id in hash parameter.
  <Accordions> <Accordion title="My Title" id="my-title"> My Content </Accordion> </Accordions>
Patch Changes
- 65b7f30: Improve search dialog design
- Updated dependencies [f39ae40]
  - next-docs-zeta@6.1.0
Dec 18
next-docs-zeta@6.1.0
Minor Changes
- f39ae40: Forward ref to Link and DynamicLink component
  
  Legacy import name SafeLink is now removed
  - import { SafeLink } from "next-docs-zeta/link" + import Link from "next-docs-zeta/link"
Dec 18
next-docs-mdx@6.1.0
Patch Changes
- Updated dependencies [f39ae40]
  - next-docs-zeta@6.1.0
Dec 18
create-next-docs-app@6.1.0
Patch Changes
- 65b7f30: Update examples
- 3e34d14: Sync version with next-docs
Dec 13
next-docs-ui@6.0.2
Patch Changes
- next-docs-zeta@6.0.2
Dec 13
next-docs-mdx@6.0.2
Patch Changes
- 1845bf5: Fixes import path for next-docs-mdx/loader-mdx
  - next-docs-zeta@6.0.2
Dec 13
next-docs-zeta@6.0.2
Dec 12
next-docs-ui@6.0.1
Patch Changes
- 515a3e1: Fix inline code blocks are not highlighted
  - next-docs-zeta@6.0.1
Dec 12
next-docs-zeta@6.0.1
Dec 12
next-docs-mdx@6.0.1
Patch Changes
- next-docs-zeta@6.0.1
Dec 12
create-next-docs-app@1.7.4
Patch Changes
- 3840ad6: Update to 6.0.0
Dec 12
next-docs-ui@6.0.0
Major Changes
- 983ede8: Remove not-found component
  
  The not-found component was initially intended to be the default 404 page. However, we found that the Next.js default one is good enough. For advanced cases, you can always build your own 404 page.
- ebe8d9f: Support Tailwind CSS plugin usage
  
  If you are using Tailwind CSS for your docs, it's now recommended to use the official plugin instead.
  const { docsUi, docsUiPlugins } = require('next-docs-ui/tailwind-plugin'); /** @type {import('tailwindcss').Config} */ module.exports = { darkMode: 'class', content: [ './components/**/*.{ts,tsx}', './app/**/*.{ts,tsx}', './content/**/*.mdx', './node_modules/next-docs-ui/dist/**/*.js', ], plugins: [...docsUiPlugins, docsUi], };
  The docsUi plugin adds necessary utilities & colors, and docsUiPlugins are its dependency plugins which should not be missing.
- 7d89e83: Add required property url to <DocsPage /> component
  
  You must pass the URL of current page to <DocsPage /> component.
  export default function Page({ params }) { return ( <DocsPage + url={page.url} toc={page.data.toc} > ... </DocsPage> ) }
  footer property is now optional
  
  Your footer property in <DocsPage /> will be automatically generated if not specified.
  findNeighbour(tree, url);
- 0599d50: Separate MDX components
  
  Previously, you can only import the code block component from next-docs-ui/mdx (Client Component) and next-docs-ui/mdx-server (Server Component).
  
  This may lead to confusion, hence, it is now separated into multiple files. You can import these components regardless it is either a client or a server component.
  
  Notice that MDXContent is now renamed to DocsBody, you must import it from next-docs-ui/page instead.
  - import { MDXContent } from "next-docs-ui/mdx" - import { MDXContent } from "next-docs-ui/mdx-server" + import { DocsBody } from "next-docs-ui/page"
  - import { Card, Cards } from "next-docs-ui/mdx" + import { Card, Cards } from "next-docs-ui/mdx/card" - import { Pre } from "next-docs-ui/mdx" + import { Pre } from "next-docs-ui/mdx/pre" - import { Heading } from "next-docs-ui/mdx" + import { Heading } from "next-docs-ui/mdx/heading" - import defaultComponents from "next-docs-ui/mdx" + import defaultComponents from "next-docs-ui/mdx/default-client" - import defaultComponents from "next-docs-ui/mdx-server" + import defaultComponents from "next-docs-ui/mdx/default"
Minor Changes
- 56a35ce: Support custom searchOptions in Algolia Search Dialog
Patch Changes
- 5c98f7f: Support custom attributes to pre element inside code blocks
- Updated dependencies [9ef047d]
  - next-docs-zeta@6.0.0
Dec 12
next-docs-mdx@6.0.0
Major Changes
- 69f8abf: Make file paths relative to rootDir when resolving files
  
  For a more simplified usage, the resolved file paths will be relative to rootDir.
  
  You can now generate slugs automatically depending on the root directory you have configured.
  const utils = fromMap(map, { rootDir: 'ui', schema: { frontmatter: frontmatterSchema, }, });
  The configuration above will generate /hello slugs for a file named /content/ui/hello.mdx, while the previous one generates /ui/hello.
- 9ef047d: Pre-bundle page urls into raw pages.
  
  This means you don't need getPageUrl anymore for built-in adapters, including next-docs-mdx and Contentlayer. It is now replaced by the url property from the pages array provided by your adapter.
  
  Due to this change, your old configuration might not continues to work.
  import { fromMap } from 'next-docs-mdx/map' fromMap({ - slugs: ... + getSlugs: ... })
  For Contentlayer, the getUrl option is now moved to createConfig.
- 1c187b9: Support intelligent schema types
  
  The validate options is now renamed to schema.
  import { defaultSchemas, fromMap } from 'next-docs-mdx/map'; const utils = fromMap(map, { rootDir: 'docs/ui', baseUrl: '/docs/ui', schema: { frontmatter: defaultSchemas.frontmatter.extend({ preview: z.string().optional(), }), }, });
  The frontmatter field on pages should be automatically inferred to your Zod schema type.
- 52b24a6: Remove /docs from default root content path
  
  Previously, the default root content path is ./content/docs. All your documents must be placed under the root directory.
  
  Since this update, it is now ./content by default. To keep the old behaviours, you may manually specify rootContentPath.
  const withNextDocs = createNextDocs({ rootContentPath: './content/docs', });
  Notice that due to this change, your baseUrl property will be / by default
  const withNextDocs = createNextDocs({ + baseUrl: "/docs" })
- 2ff7581: Rename configuration options
  
  The options of createNextDocs is now renamed to be more flexible and straightforward.
  
  Old New
  dataExports mdxOptions.valueToExport
  pluginOptions mdxOptions.rehypeNextDocsOptions
  
  rehypePlugins and remarkPlugins can also be a function that accepts and returns plugins.
Minor Changes
- 55a2321: Use @mdx-js/mdx to process MDX/markdown files.
  
  You no longer need @next/loader and @mdx-js/loader to be installed on your project, next-docs-mdx will process files with @mdx-js/mdx directly.
  
  This change will not break most of the projects
Patch Changes
- Updated dependencies [9ef047d]
  - next-docs-zeta@6.0.0
Dec 12
next-docs-zeta@6.0.0
Major Changes
- 9ef047d: Pre-bundle page urls into raw pages.
  
  This means you don't need getPageUrl anymore for built-in adapters, including next-docs-mdx and Contentlayer. It is now replaced by the url property from the pages array provided by your adapter.
  
  Due to this change, your old configuration might not continues to work.
  import { fromMap } from 'next-docs-mdx/map' fromMap({ - slugs: ... + getSlugs: ... })
  For Contentlayer, the getUrl option is now moved to createConfig.

Old	New
`dataExports`	`mdxOptions.valueToExport`
`pluginOptions`	`mdxOptions.rehypeNextDocsOptions`

Changelog

January 2024

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Major Changes

Minor Changes

Patch Changes

Major Changes

Minor Changes

Major Changes

Minor Changes

Patch Changes

Major Changes

December 2023

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Patch Changes

Major Changes

Minor Changes

Patch Changes

Major Changes

Minor Changes

Patch Changes

Major Changes

Minor Changes

Major Changes

Minor Changes

Patch Changes

Major Changes

Minor Changes

Major Changes

Minor Changes

Patch Changes

Minor Changes

Patch Changes

Minor Changes

Major Changes

Minor Changes

Patch Changes

Major Changes

Minor Changes

Patch Changes

Major Changes