CHANGELOG.md renders on the repo page and was still headed next-docs-mdx, two renames ago. The release entries below it reference upstream versions; those are a record of what shipped and stay as they are. The two JSDoc brand leaks this commit originally also carried were fixed concurrently on main, so only the title remains. Co-authored-by: Hanzo Dev <[email protected]>
29 KiB
@hanzo/mdx
14.1.1
Patch Changes
- 94693d6: Initial npm publish of @hanzo/mdx package
14.1.0
Minor Changes
- fc0e3db: Support Workspaces API [Experimental]
Patch Changes
- Updated dependencies [ef8eb6c]
- Updated dependencies [e0c4c3a]
- Updated dependencies [4e2bca7]
14.0.4
Patch Changes
- f59339b: Fix
last-modifiedplugin date checking
14.0.3
Patch Changes
- f362ea1: Fix Webpack warnings (they require absolute paths for dependencies)
- Updated dependencies [fe380da]
- Updated dependencies [ade44d0]
14.0.2
Patch Changes
- 59743c0: Use
remarkStructure().exportAsoption to exportstructuredData - 59743c0: only provide CJS fallback for Next.js
- Updated dependencies [c3b8474]
14.0.1
Patch Changes
- 52dabc3: Support type-safe collection generation
14.0.0
Major Changes
-
7b450d6: Change
postInstall()signature topostInstall({ configPath, outDir, ... })This allows more options for
postInstallcommand. -
a312d3a: Replace
getDefaultMDXOptions()withapplyMdxPreset()This allows Fumadocs MDX to support more presets in the future, and adjust presets for dynamic mode.
// source.config.ts import { defineCollections, applyMdxPreset } from "fumadocs-mdx/config"; import { myPlugin } from "./remark-plugin"; export const blog = defineCollections({ type: "doc", mdxOptions: applyMdxPreset({ remarkPlugins: [myPlugin], // You can also pass a function to control the order of remark plugins. remarkPlugins: (v) => [myPlugin, ...v], }), }); -
bc93578: Replace
lastModifiedTimeoption withlastModifiedplugin.If you've
lastModifiedTimeoption enabled before, migrate to the plugin instead.// source.config.ts import { defineConfig } from "fumadocs-mdx/config"; import lastModified from "fumadocs-mdx/plugins/last-modified"; export default defineConfig({ plugins: [lastModified()], }); -
2f7e4d8: Drop support for multiple
dirin same collectionConsider using
filesinstead for filtering files.// source.config.ts import { defineDocs } from "fumadocs-mdx/config"; export const docs = defineDocs({ dir: "content/guides", docs: { files: ["./i-love-fumadocs/**/*.{md,mdx}"], }, }); -
a312d3a: No longer generate
extractedReferencesby defaultYou can enable it from
postprocessoption.// source.config.ts import { defineDocs } from "fumadocs-mdx/config"; export const docs = defineDocs({ docs: { postprocess: { extractLinkReferences: true, }, }, }); -
b963021: [Vite] rename
generateIndexFileoption toindex
Patch Changes
- 97722c6: Fix meta file validation on Bun.
- b963021: [Internal] Make
index-filea plugin and optimize re-generations. - Updated dependencies [c5c00e9]
13.0.8
Patch Changes
- 58bf979: [Bun Loader] Support dynamic require of meta files
- Updated dependencies [ff68f69]
- Updated dependencies [00058c8]
13.0.7
Patch Changes
- 30b1b11: Temporary workaround for
vite:jsonplugin conflicts - Updated dependencies [733b01e]
13.0.6
Patch Changes
- 40176ce: Support
disableMetaFileoption in Bun plugin
13.0.5
Patch Changes
- ad38466: add support next.config.mts for mdx
13.0.4
Patch Changes
- 27fc4ed: [Internal] improve mutability of
LoadedConfigfor plugins - f5bc4aa: Fix Bun missing query strings
- 61b90c8: Always transform meta files in collection, this includes runtime loaders like Node.js and Bun.
- d1e43f4: Support re-generating index file when using runtime: bun | node
- Updated dependencies [f97cd1e]
- Updated dependencies [f7e15e2]
13.0.3
Patch Changes
- cd087d2: fix hot reload
- 94d1ad5: Support generating extra index file for browser (workaround for Cloudflare Vite issues)
- Updated dependencies [b95b0cf]
13.0.2
Patch Changes
- ee4ad3d: Always format file paths into POSIX for Vite
13.0.1
Patch Changes
- 56332df: Support plugins in Webpack loader environment: now plugins can apply changes on MDX options too.
- 91add4f: Plugin
json-schema: support inserting$schemato JSON files - cffd4c2: Lazy update index files on Next.js
13.0.0
Major Changes
-
8d0c164: Move
createMDXSourceandresolveFilesfromfumadocs-mdxtofumadocs-mdx/runtime/next -
3caa5cd: Vite: move
source.generated.tsto.source/index.tsWhy:
- with Fumadocs MDX Plugins, we want to unify the output directory across Vite & Next.js.
source.generated.tslooks ugly compared by.source.
Migrate:
- run dev server/typegen to generate a
.sourcefolder. - import it over the original
source.generated.ts. - note that both docs and
create-fumadocs-appare updated to.sourcefolder.
Minor Changes
-
29ce826: Support JSON Schema plugin (
fumadocs-mdx/plugins/json-schema) -
3caa5cd: Support Plugins API
Fumadocs MDX is mostly a bundler plugin meant to be used with tools like Vite and Turbopack.
With Fumadocs MDX Plugins, you can extend Fumadocs MDX without worrying the underlying bundler. It is designed for:
- Generate files from config (e.g. types, index files, JSON schemas)
- Modify received config
Patch Changes
- 81fa875: Fix
includeProcessedMarkdowncannot stringify MDX nodes - 575cfb8: Include unravel plugin into
remark-includeparsing step, this ensures the parsed results are consistent with normal MDX.js processor output. - 1f1c787: Add
useContentAPI to client loader for avoiding Lint errors - 9051574: Support
postprocess.includeMDASToption - a5df956: Support
runtime: bunandruntime: nodein Vite index file generation - 5210f18: Support Fumadocs 16 in
peerDependencies. - Updated dependencies [230c6bf]
- Updated dependencies [851897c]
- Updated dependencies [4049ccc]
- Updated dependencies [429c41a]
- Updated dependencies [5210f18]
- Updated dependencies [cbc93e9]
- Updated dependencies [42f09c3]
- Updated dependencies [55afd8a]
- Updated dependencies [5210f18]
- [email protected]
- @fumadocs/[email protected]
12.0.3
Patch Changes
- a55177c: Remove
Overridetype utility on output collection types - Updated dependencies [ce2be59]
- Updated dependencies [31b9494]
12.0.2
Patch Changes
- a3a14e7: Bump deps
- Updated dependencies [a3a14e7]
- @fumadocs/[email protected]
- [email protected]
12.0.1
Patch Changes
- af50bc8: Support customising index file output path in Vite
- 5fc9ee4: Support
remark-directivefor Include API - 4b9871d: MDX Async mode: read file content on load
- Updated dependencies [655bb46]
- Updated dependencies [d1ae3e8]
- Updated dependencies [6548a59]
- Updated dependencies [51268ec]
- Updated dependencies [51268ec]
12.0.0
Major Changes
-
f11f89d: [Next.js] Rename APIS
On page data:
_file->info._file.absolutePath->info.fullPath.
-
effe43d: Drop support for Zod 3 schemas
Zod 3 schemas are still allowed, but you cannot no longer extend on the Zod 4 schemas provided by Fumadocs.
-
2862a10: [Next.js] Removed
contenton page data in favour ofgetText().
Minor Changes
- 22e0fec: Support
getText()& Postprocess API - 2862a10: Unify doc collection entry for both Vite and Next.js integrations
11.10.1
Patch Changes
- da095ac: Refactor internal export paths
- 854d4ef: Export
postInstall()function fromfumadocs-mdx/vite - Updated dependencies [982aed6]
11.10.0
Minor Changes
- ea13374: Support runtime loaders: Node.js, Bun
Patch Changes
- Updated dependencies [846b28a]
- Updated dependencies [2b30315]
11.9.1
Patch Changes
- 64d0169: hotfix node.js imports at global scope
11.9.0
Minor Changes
- d193152: Support
absolutePathon Vite
Patch Changes
- 2566eef: Support postinstall script on Vite
- Updated dependencies [c948f59]
11.8.3
Patch Changes
- 205d92d: Update dev server initialization for Next.js 15.5.1
- e4c12a3: Add Vite config for Fumadocs Core & UI automatically
- Updated dependencies [f65778d]
- Updated dependencies [e4c12a3]
11.8.2
Patch Changes
- 9a3c23b: support auto-generated title based on
h1heading - 9cb829c: Support referencing heading in
<include>without sections
11.8.1
Patch Changes
- 5f2ec6e: Fix
remark-mdx-exportsplugin fallback - Updated dependencies [6d97379]
- Updated dependencies [e776ee5]
11.8.0
Minor Changes
- cfe2a5c: Support Async Mode for Vite
Patch Changes
- c8f49d8: Include frontmatter into
page.data.contentby default - Updated dependencies [514052e]
- Updated dependencies [e254c65]
- Updated dependencies [ec75601]
- Updated dependencies [e785f98]
- Updated dependencies [0531bf4]
- Updated dependencies [50eb07f]
- Updated dependencies [67df155]
- Updated dependencies [b109d06]
11.7.5
Patch Changes
- c17fa03: Support creating a separate processor when
<include />points to different Markdown format - f43f714: Automatic fallback to Zod v3 when app has explicit v3 dependency
- Updated dependencies [569bc26]
- Updated dependencies [817c237]
11.7.4
Patch Changes
- a0148f9: Remark Include: Support copying only a section
11.7.3
Patch Changes
- 4f8f1d6: Add
vite/clienttypes in generated file - 57224f4: Support last modified time for Vite
11.7.2
Patch Changes
- e75ec55: Support last modified time for Vite
11.7.1
Patch Changes
- f8000f4: Generate config based on Next.js version
- f45a1b6: Support Tanstack Router/Start via
createClientLoader - Updated dependencies [1b0e9d5]
11.7.0
Minor Changes
- f8a58c6: Support
preset: minimalto disable Fumadocs specific defaults - e5cfa27: Stabilize Vite plugin support
Patch Changes
- Updated dependencies [658fa96]
- Updated dependencies [f8a58c6]
- [email protected]
- @fumadocs/[email protected]
11.6.11
Patch Changes
- 73e07a5: bump zod to v4
11.6.10
Patch Changes
- d0f8a15: Enable
remarkNpmby default, replaceremarkInstallwith it. - Updated dependencies [d0f8a15]
- Updated dependencies [84918b8]
- Updated dependencies [f8d1709]
- [email protected]
- @fumadocs/[email protected]
11.6.9
Patch Changes
- cd86f58: Hotfix Windows EOL being ignored
- Updated dependencies [7d1ac21]
11.6.8
Patch Changes
- 7a45921: Add
absolutePathandpathproperties to pages, markfileas deprecated - 1b7bc4b: Add
@types/reactto optional peer dependency to avoid version conflict in monorepos - 14e267b: Use custom util to parse frontmatter
- Updated dependencies [7a45921]
- Updated dependencies [1b7bc4b]
- [email protected]
- @fumadocs/[email protected]
11.6.7
Patch Changes
- a5c283f: Support
outDiroption oncreateMDX() - Updated dependencies [b4916d2]
- Updated dependencies [8738b9c]
- Updated dependencies [a66886b]
11.6.6
Patch Changes
- cd42e78: Support last modified time on Async Mode
- Updated dependencies [1b999eb]
- Updated dependencies [961b67e]
- Updated dependencies [7d78bc5]
11.6.5
Patch Changes
- a6c909b: Removed unused devDependencies and migrated from
fast-globtotinyglobby - Updated dependencies [a6c909b]
- @fumadocs/[email protected]
- [email protected]
11.6.4
Patch Changes
- 4ae7b4a: Support MDX in codeblock tab value
- Updated dependencies [4ae7b4a]
- @fumadocs/[email protected]
- [email protected]
11.6.3
Patch Changes
- 4de7fe7: Fix
meta.{locale}file being excluded fromdefineDocs - Updated dependencies [c05dc03]
11.6.2
Patch Changes
- 16c7566: Improve error handling logic on parsing meta entries
- 7b89faa: Add
page.data.contentto sync mode
11.6.1
Patch Changes
- 434ccb2: Improve performance
11.6.0
Minor Changes
- 7fcf612: Require Next.js 15.3.0 or above
Patch Changes
- Updated dependencies [ec85a6c]
- Updated dependencies [e1a61bf]
11.5.8
Patch Changes
- 6c5e47a: add default types for collection without schema
- Updated dependencies [1057957]
11.5.7
Patch Changes
- 5163e92: Support reusing codeblocks in
<include> - Updated dependencies [c5add28]
- Updated dependencies [6493817]
- Updated dependencies [f3cde4f]
- Updated dependencies [7c8a690]
- Updated dependencies [b812457]
- [email protected]
- @fumadocs/[email protected]
11.5.6
Patch Changes
- 927ee8b: Fix hot reload
11.5.5
Patch Changes
- e6df8aa: Improve performance
11.5.4
Patch Changes
- fc5d7c0: Compile Meta files into inline JSON objects
- Updated dependencies [5deaf40]
11.5.3
Patch Changes
- 65ae933: Fix dependencies
11.5.2
Patch Changes
- c571417: Improve performance
- be3acf4: Improve types
11.5.1
Patch Changes
- 3730739: Fix types errors
11.5.0
Minor Changes
- 233a2d1: Support Standard Schema for collection
schema - 432c7bd: Support
defineDocswithout re-exportingdocsandmetacollections
Patch Changes
- Updated dependencies [69f20cb]
- @fumadocs/[email protected]
- [email protected]
11.4.1
Patch Changes
- a8e9e1f: Bump deps
11.4.0
Minor Changes
- 421166a: Improve performance, remove unused imports
Patch Changes
- 421166a: Fix Fumadocs 14 compatibility issues
11.3.2
Patch Changes
- a89d6e0: Support Fumadocs v15
- d6781cc: Fix incorrect line number with frontmatter on dev mode
- Updated dependencies [5b8cca8]
- Updated dependencies [a763058]
- Updated dependencies [581f4a5]
11.3.1
Patch Changes
- 69bd4fe: Fix nested references for
<include /> - Updated dependencies [bb73a72]
- Updated dependencies [69bd4fe]
11.3.0
Minor Changes
- a4eb326: Deprecate
generateManifestoption: use a route handler to export build time information
Patch Changes
- 7cc9f1f: Support CommonJs usage temporarily
11.2.3
Patch Changes
- 0a5b08c: Fix alias imports
- Updated dependencies [72dc093]
11.2.2
Patch Changes
- 97ed36c: Improve default settings
- Updated dependencies [97ed36c]
11.2.1
Patch Changes
- 3445182: Fix
includehot-reload issues - Updated dependencies [b71064a]
11.2.0
Minor Changes
- bd0a140: Support reusing content with
includetag
Patch Changes
11.1.2
Patch Changes
- fe36593: Fix global config types
11.1.1
Patch Changes
- 164b9e6: Fix non-absolute
diroption - Updated dependencies [1573d63]
11.1.0
Minor Changes
- 28a9c3c: Migrate loaders to ESM only
11.0.0
Major Changes
- e094284: Require Fumadocs v14
Patch Changes
10.1.0
Minor Changes
- 5cef1f1: Move
diroption fromdefineDocs - e1ee822: Support hast nodes in
tocvariable - df9e0e1: Support
asyncoutput mode
Patch Changes
- 9a964ca: expose
startfunction from loader - e612f2a: Make compatible with Next.js 15
- 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]
10.0.2
Patch Changes
- f21c871: Change cache path of manifest files
- Updated dependencies [78e59e7]
10.0.1
Patch Changes
- 7e23388: Fix windows compatibility
10.0.0
Major Changes
-
ed83d01: Support declarative collections
why: This allows Fumadocs MDX to be more flexible.
migrate:
You don't need
exportsanymore, properties are merged into one object by default.- page.data.exports.toc + page.data.toc - page.data.exports.default + page.data.bodyA
source.config.tsis now required.import { defineDocs, defineConfig } from "fumadocs-mdx/config"; export const { docs, meta } = defineDocs(); export default defineConfig();The
mdx-components.tsxfile is no longer used, pass MDX components to body instead.Search indexes API is now replaced by Manifest API.
Please refer to the docs for further details.
Patch Changes
- 0c251e5: Bump deps
- Updated dependencies [7dabbc1]
- Updated dependencies [0c251e5]
- Updated dependencies [3b56170]
9.0.4
Patch Changes
- 95dbba1: Support passing remark structure options
- Updated dependencies [95dbba1]
9.0.3
Patch Changes
- c0d1faf: Store additional
_datato search indexes
9.0.2
Patch Changes
- 61b91fa: Improve Fumadocs OpenAPI support
- Updated dependencies [36b771b]
- Updated dependencies [61b91fa]
9.0.1
Patch Changes
- c7aa090: Improve Fumadocs OpenAPI support
- Updated dependencies [17fa173]
9.0.0
Major Changes
- 1f1989e: Support Fumadocs v13
Patch Changes
8.2.34
Patch Changes
- c2d956b: Support mirror pages for symlinks of MDX file
8.2.33
Patch Changes
- 78acd55: Use full mode on docs pages by default on OpenAPI generated pages
8.2.32
Patch Changes
- 2eb68c8: Force a release of content sources
8.2.31
Patch Changes
- 310e0ab: Move
fumadocs-coreto peer dependency - Updated dependencies [053609d]
8.2.30
Patch Changes
8.2.29
Patch Changes
8.2.28
Patch Changes
- Updated dependencies [98430e9]
- Updated dependencies [d88dfa6]
- Updated dependencies [ba20694]
- Updated dependencies [57eb762]
8.2.27
Patch Changes
- Updated dependencies [1b8e12b]
8.2.26
Patch Changes
8.2.25
Patch Changes
- 17e162e: Add
mdxto page extensions by default - Updated dependencies [917d87f]
8.2.24
Patch Changes
8.2.23
Patch Changes
8.2.22
Patch Changes
8.2.21
Patch Changes
- 66a100d: Improve error messages
- Updated dependencies [88008b1]
- Updated dependencies [944541a]
- Updated dependencies [07a9312]
8.2.20
Patch Changes
8.2.19
Patch Changes
- 8ef2b68: Bump deps
- Updated dependencies [8ef2b68]
- Updated dependencies [26f464d]
- Updated dependencies [26f464d]
8.2.18
Patch Changes
8.2.17
Patch Changes
- Updated dependencies [98258b5]
8.2.16
Patch Changes
- Updated dependencies [f7c2c5c]
8.2.15
Patch Changes
- 5653d5d: Support customising heading id in headings
- 5653d5d: Support custom heading slugger
- Updated dependencies [5653d5d]
- Updated dependencies [5653d5d]
8.2.14
Patch Changes
8.2.13
Patch Changes
- 7b61b2f: Migrate
fumadocs-uito fully ESM, adding support for ESMtailwind.configfile - Updated dependencies [7b61b2f]
8.2.12
Patch Changes
8.2.11
Patch Changes
8.2.10
Patch Changes
8.2.9
Patch Changes
- Updated dependencies [2d8df75]
- Updated dependencies [92cb12f]
- Updated dependencies [f75287d]
- Updated dependencies [2d8df75]
8.2.8
Patch Changes
- Updated dependencies [bbad52f]
8.2.7
Patch Changes
8.2.6
Patch Changes
- Updated dependencies [779c599]
- Updated dependencies [0c01300]
- Updated dependencies [779c599]
8.2.5
Patch Changes
8.2.4
Patch Changes
- e47c62f: Support customising included files in the map file
- Updated dependencies [e47c62f]
8.2.3
Patch Changes
8.2.2
Patch Changes
- Updated dependencies [6f321e5]
8.2.1
Patch Changes
- Updated dependencies [10e099a]
8.2.0
Minor Changes
- 01155f5: Support generate search indexes in build time
Patch Changes
- Updated dependencies [c9b7763]
- Updated dependencies [0e78dc8]
- Updated dependencies [d8483a8]
8.1.1
Patch Changes
- Updated dependencies [b5d16938]
- Updated dependencies [321d1e1f]
8.1.0
Minor Changes
- 1c388ca5: Support
defaultOpenfor folder nodes
Patch Changes
- Updated dependencies [909b0e35]
- Updated dependencies [691f12aa]
- Updated dependencies [1c388ca5]
8.0.5
Patch Changes
8.0.4
Patch Changes
8.0.3
Patch Changes
- 9bf5adb: Replace await imports with normal imports
- Updated dependencies [5c24659]
8.0.2
Patch Changes
8.0.1
Patch Changes
- 6c5a39a: Rename Git repository to
fumadocs - Updated dependencies [6c5a39a]
- Updated dependencies [eb028b4]
- Updated dependencies [054ec60]
8.0.0
Major Changes
-
1a346a1: Enable
remark-imageplugin by defaultYou can add image embeds easily. They will be converted to static image imports.
Become:
import img_banner from "../../public/image.png"; <img alt="banner" src={img_banner} /> -
2b11c20: Rename to Fumadocs
next-docs-zeta->fumadocs-corenext-docs-ui->fumadocs-uinext-docs-mdx->fumadocs-mdx@fuma-docs/openapi->fumadocs-openapicreate-next-docs-app->create-fumadocs-app
Patch Changes
- Updated dependencies [2ea9437]
- Updated dependencies [cdff313]
- Updated dependencies [1a346a1]
- Updated dependencies [2b11c20]
7.1.2
Patch Changes
7.1.1
Patch Changes
7.1.0
Patch Changes
7.0.0
Major Changes
-
9929c5b: Prefer
.map.tsinstead of_map.tsUnless you have especially configured, now it uses
.map.tsby default.- import map from "@/_map" + import map from "@/.map" -
9929c5b: Migrate to Source API
fromMaphas been removed. Please usecreateMDXSourceinstead.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]
6.1.0
Patch Changes
- Updated dependencies [f39ae40]
6.0.2
Patch Changes
- 1845bf5: Fixes import path for next-docs-mdx/loader-mdx
6.0.1
Patch Changes
6.0.0
Major Changes
-
69f8abf: Make file paths relative to
rootDirwhen resolving filesFor 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
/helloslugs 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
getPageUrlanymore for built-in adapters, includingnext-docs-mdxand Contentlayer. It is now replaced by theurlproperty 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
getUrloption is now moved tocreateConfig. -
1c187b9: Support intelligent schema types
The
validateoptions is now renamed toschema.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
frontmatterfield on pages should be automatically inferred to your Zod schema type. -
52b24a6: Remove
/docsfrom default root content pathPreviously, the default root content path is
./content/docs. All your documents must be placed under the root directory.Since this update, it is now
./contentby default. To keep the old behaviours, you may manually specifyrootContentPath.const withNextDocs = createNextDocs({ rootContentPath: "./content/docs", });Notice that due to this change, your
baseUrlproperty will be/by defaultconst withNextDocs = createNextDocs({ + baseUrl: "/docs" }) -
2ff7581: Rename configuration options
The options of
createNextDocsis now renamed to be more flexible and straightforward.Old New dataExportsmdxOptions.valueToExportpluginOptionsmdxOptions.rehypeNextDocsOptionsrehypePluginsandremarkPluginscan also be a function that accepts and returns plugins.
Minor Changes
-
55a2321: Use
@mdx-js/mdxto process MDX/markdown files.You no longer need
@next/loaderand@mdx-js/loaderto be installed on your project,next-docs-mdxwill process files with@mdx-js/mdxdirectly.This change will not break most of the projects
Patch Changes
- Updated dependencies [9ef047d]
5.0.0
Minor Changes
- de44efe: Migrate to Shikiji
- de44efe: Support code highlighting options
Patch Changes
- Updated dependencies [de44efe]
- Updated dependencies [de44efe]
4.0.9
Patch Changes
- Updated dependencies [a883009]
4.0.8
Patch Changes
- Updated dependencies [e0c5c96]
4.0.7
Patch Changes
- b9af5ed: Update tsup & dependencies
- Updated dependencies [b9af5ed]
4.0.6
Patch Changes
- Updated dependencies [ff38f6e]
4.0.5
Patch Changes
4.0.4
Patch Changes
4.0.3
Patch Changes
- ba51a9f: Support custom slugs function
- 0cc10cb: Support custom build page tree options
- Updated dependencies [0cc10cb]
4.0.2
Patch Changes
- 347df32: Fix empty
baseUrlunexpected behaviours - ad7b8a8: Fully support custom root content directory paths
- 73f985a: Support
rootDirAPI
4.0.1
Patch Changes
- 01b23e2: Support Next.js 14
- Updated dependencies [2da93d8]
- Updated dependencies [01b23e2]
4.0.0
Patch Changes
- Updated dependencies [6c4a782]
- Updated dependencies [6c4a782]
4.0.0
Patch Changes
- Updated dependencies [678cd3d]
- Updated dependencies [24245a3]
3.0.0
Patch Changes
- Updated dependencies [1043532]
- Updated dependencies [7a0690b]
- Updated dependencies [a4a8120]