# Docs

## cli

- [create-fumadocs-app](/docs/cli/create-fumadocs-app): The CLI to create new Fumadocs apps
- [User Guide](/docs/cli): The CLI tool that automates setups and installs components.

## headless

- [Custom Source](/docs/headless/custom-source): Build your own content source
- [Introduction](/docs/headless): Getting started with core library
- [Internationalization](/docs/headless/internationalization): Support multiple languages in your documentation
- [Page Slugs & Page Tree](/docs/headless/page-conventions): Customise generated page slugs and page tree.
- [Page Tree](/docs/headless/page-tree): The structure of page tree.
- [Breadcrumb](/docs/headless/components/breadcrumb): The navigation component at the top of the screen
- [Components](/docs/headless/components): Blocks for your docs
- [Link](/docs/headless/components/link): A Link component that handles external links
- [TOC](/docs/headless/components/toc): Table of Contents
- [Content Collections](/docs/headless/content-collections): Use Content Collections for Fumadocs
- [Headings](/docs/headless/mdx/headings): Process headings from your document
- [MDX Plugins](/docs/headless/mdx): Useful remark & rehype plugins for your docs.
- [Package Install](/docs/headless/mdx/install): Generate code blocks for installing packages
- [Rehype Code](/docs/headless/mdx/rehype-code): Code syntax highlighter
- [Remark Admonition](/docs/headless/mdx/remark-admonition): Use Admonition in Fumadocs
- [Remark Image](/docs/headless/mdx/remark-image): Adding size attributes to images.
- [Remark Files](/docs/headless/mdx/remark-mdx-files): Generate files from codeblocks.
- [Remark TS to JS](/docs/headless/mdx/remark-ts2js): A remark plugin to transform TypeScript codeblocks into two tabs of codeblock with its JavaScript variant.
- [Remark Structure](/docs/headless/mdx/structure): Extract information from your documents, useful for implementing document search
- [Algolia Search](/docs/headless/search/algolia): Integrate Algolia Search with Fumadocs
- [Search](/docs/headless/search): Configure Search in Fumadocs
- [Mixedbread](/docs/headless/search/mixedbread): Integrate Mixedbread Search with Fumadocs
- [Orama Cloud](/docs/headless/search/orama-cloud): Integrate with Orama Cloud
- [Built-in Search](/docs/headless/search/orama): Built-in document search of Fumadocs
- [Trieve Search](/docs/headless/search/trieve): Integrate Trieve Search with Fumadocs
- [Loader API](/docs/headless/source-api): Turn a content source into a unified interface
- [Loader Plugins](/docs/headless/source-api/plugins): Extend Loader API
- [Source](/docs/headless/source-api/source): Setup sources for Loader API
- [Find Neighbours](/docs/headless/utils/find-neighbour): Find the neighbours of a page from the page tree
- [Get TOC](/docs/headless/utils/get-toc): Parse Table of contents from markdown/mdx content
- [Last Modified Time](/docs/headless/utils/git-last-edit): Get the last edit time of a file in Github repository
- [Utilities](/docs/headless/utils): Utilities to provide extra functionality to your docs
- [Negotiation](/docs/headless/utils/negotiation): Tiny wrapper for negotiation features.

## mdx

- [Async Mode](/docs/mdx/async): Runtime compilation of content files.
- [Collections](/docs/mdx/collections): Collection of content data for your app
- [Global Options](/docs/mdx/global): Customise Fumadocs MDX
- [Include](/docs/mdx/include): Reuse content from other files.
- [Getting Started](/docs/mdx): Introducing Fumadocs MDX, the official content source of Fumadocs.
- [Last Modified Time](/docs/mdx/last-modified): Output the last modified time of a document
- [MDX Presets](/docs/mdx/mdx): Customise the default configurations for MDX processor.
- [Import MDX Files](/docs/mdx/page): Importing MDX files directly
- [Performance](/docs/mdx/performance): The performance of Fumadocs MDX
- [Postprocess](/docs/mdx/postprocess): Include useful information after compilation of content files.
- [Generate Types](/docs/mdx/typegen): Generate types without running dev/build server
- [Next.js](/docs/mdx/next): Use Fumadocs MDX with Next.js
- [Bun](/docs/mdx/loader/bun): Access content in Bun.
- [Loader](/docs/mdx/loader): Fumadocs MDX loader integration.
- [Node.js](/docs/mdx/loader/node): Access content in Node.js runtime.
- [React Router](/docs/mdx/vite/react-router): Use Fumadocs MDX with React Router
- [Tanstack Start](/docs/mdx/vite/tanstack): Use Fumadocs MDX with Tanstack Start & Router
- [Waku](/docs/mdx/vite/waku): Use Fumadocs MDX with Waku

## openapi

- [Scalar Example](/docs/openapi): View the Scalar Galaxy example OpenAPI schema.
- [Get all planets](/docs/openapi/getAllData): It’s easy to say you know them all, but do you really? Retrieve all the planets and check whether you missed one.
- [Create a planet](/docs/openapi/createPlanet): Time to play god and create a new planet. What do you think? Ah, don’t think too much. What could go wrong anyway?
- [Get a planet](/docs/openapi/getPlanet): You’ll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone.
- [Delete a planet](/docs/openapi/deletePlanet): This endpoint was used to delete planets. Unfortunately, that caused a lot of trouble for planets with life. So, this endpoint is now deprecated and should not be used anymore.
- [Update a planet](/docs/openapi/updatePlanet): Sometimes you make mistakes, that's fine. No worries, you can update all planets.
- [Upload an image to a planet](/docs/openapi/uploadImage): Got a crazy good photo of a planet? Share it with the world!
- [Create a user](/docs/openapi/createUser): Time to create a user account, eh?
- [Get a token](/docs/openapi/getToken): Yeah, this is the boring security stuff. Just get your super secret token and move on.
- [Get authenticated user](/docs/openapi/getMe): Find yourself they say. That’s what you can do here.
- [New Planet](/docs/openapi/newplanet): undefined

## ui

- [Comparisons](/docs/ui/comparisons): How is Fumadocs different from other existing frameworks?
- [Deploying](/docs/ui/deploying): Deploy your Fumadocs app
- [Quick Start](/docs/ui): Getting Started with Fumadocs
- [Obsidian](/docs/ui/obsidian): Render your Obsidian vaults in Fumadocs.
- [Page Slugs & Page Tree](/docs/ui/page-conventions): A shared convention for organizing your documents
- [Python](/docs/ui/python): Generate docs from Python
- [Static Build](/docs/ui/static-export): Output static website with Fumadocs.
- [Typescript](/docs/ui/typescript): Generate docs from Typescript definitions
- [Versioning](/docs/ui/versioning): Implementing multi-version in your docs.
- [What is Fumadocs](/docs/ui/what-is-fumadocs): Introducing Fumadocs, a docs framework that you can break.
- [Export PDF](/docs/ui/export-pdf): Export docs pages as PDF documents
- [Feedback](/docs/ui/feedback): Receive feedback from your users
- [AI & LLMs](/docs/ui/llms): Integrate AI functionality to Fumadocs.
- [next/og](/docs/ui/next-seo): Usage with Next.js Metadata API.
- [RSS Feed](/docs/ui/rss): Generate a RSS feed for your docs/blog.
- [Validate Links](/docs/ui/validate-links): Ensure your links are correct.
- [Themes](/docs/ui/theme): Add Theme to Fumadocs UI
- [Internationalization](/docs/ui/internationalization): Support multiple languages in your documentation
- [Next.js](/docs/ui/internationalization/next): Support i18n routing on your Next.js + Fumadocs app
- [React Router](/docs/ui/internationalization/react-router): Support i18n routing on your React Router + Fumadocs app.
- [Tanstack Start](/docs/ui/internationalization/tanstack-start): Support i18n routing on your Tanstack Start + Fumadocs app.
- [Manual Installation](/docs/ui/manual-installation): Add Fumadocs to existing projects.
- [Next.js](/docs/ui/manual-installation/next): Setup Fumadocs on Next.js.
- [React Router](/docs/ui/manual-installation/react-router): Setup Fumadocs on React Router.
- [Tanstack Start](/docs/ui/manual-installation/tanstack-start): Setup Fumadocs on Tanstack Start.
- [Waku](/docs/ui/manual-installation/waku): Setup Fumadocs on Waku.
- [Markdown](/docs/ui/markdown): How to write documents
- [Math](/docs/ui/markdown/math): Writing math equations in Markdown/MDX.
- [Mermaid](/docs/ui/markdown/mermaid): Rendering diagrams in your docs
- [Twoslash](/docs/ui/markdown/twoslash): Use Typescript Twoslash in your docs
- [Navigation](/docs/ui/navigation): Configure navigation in your Fumadocs app.
- [Layout Links](/docs/ui/navigation/links): Customise the shared navigation links on all layouts.
- [Sidebar Links](/docs/ui/navigation/sidebar): Customise sidebar navigation links on Docs Layout.
- [Configurations](/docs/ui/openapi/configurations): Customise Fumadocs OpenAPI
- [OpenAPI](/docs/ui/openapi): Generating docs for OpenAPI schema
- [Media Adapters](/docs/ui/openapi/media-adapters): Support other media types
- [Creating Proxy](/docs/ui/openapi/proxy): Avoid CORS problem
- [Algolia](/docs/ui/search/algolia): Using Algolia with Fumadocs UI.
- [Search](/docs/ui/search): Implement document search in your docs
- [Mixedbread](/docs/ui/search/mixedbread): Using Mixedbread with Fumadocs UI.
- [Orama Cloud](/docs/ui/search/orama-cloud): Using Orama Cloud with Fumadocs UI.
- [Orama (default)](/docs/ui/search/orama): The default search engine powered by Orama.
- [Docs Layout](/docs/ui/layouts/docs): The layout of documentation
- [Home Layout](/docs/ui/layouts/home-layout): Shared layout for other pages
- [Notebook](/docs/ui/layouts/notebook): A more compact version of Docs Layout
- [Docs Page](/docs/ui/layouts/page): A page in your documentation
- [Root Provider](/docs/ui/layouts/root-provider): The context provider of Fumadocs UI.
- [Accordion](/docs/ui/components/accordion): Add Accordions to your documentation
- [Auto Type Table](/docs/ui/components/auto-type-table): Auto-generated type table
- [Banner](/docs/ui/components/banner): Add a banner to your site
- [Code Block](/docs/ui/components/codeblock): Displaying Shiki highlighted code blocks
- [Code Block (Dynamic)](/docs/ui/components/dynamic-codeblock): A codeblock that also highlights code
- [Files](/docs/ui/components/files): Display file structure in your documentation
- [GitHub Info](/docs/ui/components/github-info): Display your GitHub repository information
- [Graph View](/docs/ui/components/graph-view): A graph of all pages.
- [Zoomable Image](/docs/ui/components/image-zoom): Allow zoom-in images in your documentation
- [Components](/docs/ui/components): Additional components to improve your docs
- [Inline TOC](/docs/ui/components/inline-toc): Add Inline TOC into your documentation
- [Steps](/docs/ui/components/steps): Adding steps to your docs
- [Tabs](/docs/ui/components/tabs): A Tabs component built with Radix UI, with additional features such as persistent and shared value.
- [Type Table](/docs/ui/components/type-table): A table for documenting types