Navigation
Configure navigation in your Fumadocs app.
Overview
Fumadocs UI provides different layouts to display content, you can specify navigation configurations via layouts.
Layout Links
Display navigation links in your layouts.
It is useful for linking to frequently used resources like showcase and pricing pages.
Sidebar Items
Sidebar renders links to all documentation pages.
Under the hood, Page Tree is used to represent the navigation structure.
Versioning
It's common for developer tool related docs to version their docs, such as different docs for v1 and v2 of the same tool.
You can implement multi-version in your docs in your preferred way, using the primitives provided by Fumadocs.
Partial Versioning
When versioning only applies to part of your docs, You can separate them by folders.
For example:
Good to Know
When grouping with folders, you can display them as tabs 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?
Last updated on