Documentation Build

This guide explains how to build and deploy the Kodosumi documentation using Fumadocs.

Prerequisites

Before building the documentation, ensure you have the following installed:

• Node.js (version 18 or higher)
• npm or pnpm

Installation

Install dependencies from the project root:

npm install
# or
pnpm install

Local Development

To run the documentation locally for development:

npm run dev
# or
pnpm dev

The documentation will be available at http://localhost:3000.

Building for Production

To build the documentation for production deployment:

npm run build
# or
pnpm build

This will run fumadocs-mdx, generate OpenAPI docs, and create a production build in the .next directory.

Getting Help

• Check the Fumadocs documentation
• Review the Fumadocs MDX guide
• Report issues to the Kodosumi GitHub repository