Skip to content

Repository files navigation

docs

This is a Next.js application generated with Create Fumadocs.

Run development server:

npm run dev
# or
pnpm dev
# or
yarn dev

Open http://localhost:3000/docs/ with your browser to see the result.

Static deployment

The site is built for /docs/. Run npm run build and serve the generated out/ directory with this Nginx configuration inside the HTTPS server block:

location = /docs {
    return 301 /docs/;
}

location ^~ /docs/ {
    alias /home/ubuntu/web/docs/out/;
    index index.html;
}

The base path is defined in lib/base-path.mjs. Next.js prefixes its assets and internal links; public image URLs use withBasePath. Fonts are bundled from CSS. Rebuild after changing the base path or pulling updates on the server.

Static exports do not support Next.js Proxy or request-time content negotiation. Markdown is available directly at /docs/llms.mdx/docs/<slug>/content.md, with indexes at /docs/llms.txt and /docs/llms-full.txt.

Explore

In the project, you can see:

  • lib/source.ts: Code for content source adapter, loader() provides the interface to access your content.
  • lib/layout.shared.tsx: Shared options for layouts, optional but preferred to keep.
Route Description
app/(docs) The root documentation layout and pages.
app/api/search/route.ts The Route Handler for search.

Fumadocs MDX

Collections are defined with the Macro API in lib/source.ts.

Read the Introduction for further details.

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources:

About

uno docs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages