Fumadocs

Versioning

Implementing multi-version in your docs.

Overview

It's common for developer tool related docs to version their docs, such as different docs for v1 and v2 of the same tool.

Fumadocs provide the primitives for you to implement versioning on your own way.

Partial Versioning

When versioning only applies to part of your docs, You can separate them by folders.

For example:

getting-started.mdx
getting-started.mdx

Good to Know

You may want to group them with tabs rather than folders using Sidebar Tabs.

Full Versioning

Sometimes you want to version the entire website, such as https://v14.fumadocs.dev (Fumadocs v14) and https://fumadocs.dev (Latest Fumadocs).

You can create a Git branch for a version of docs (call it v2 for example), and deploy it as a separate app on another subdomain like v2.my-site.com.

Optionally, you can link to the other versions from your docs. This design allows some advantages over partial versioning:

  • Easy maintenance: Old docs/branches won't be affected when you iterate or upgrade dependencies.
  • Better consistency: Not just the docs itself, your landing page (and other pages) will also be versioned.

How is this guide?

On this page