Documentation

Korgrid Portal ships with Fumadocs. Fumadocs is a powerful documentation framework integrated into Korgrid Portal, designed to make creating beautiful and functional documentation a breeze.

Documentation Pages

Getting Started

Quick start guide to help you begin working with the documentation

Components

Example components with code blocks and syntax highlighting

API Reference

API documentation with tables and structured examples

Test Page

Original test page demonstrating Fumadocs features

Key Features

  • Sleek, responsive design out of the box
  • Built-in search functionality for easy content discovery
  • Automatic table of contents generation
  • Support for MDX and React components
  • Dark mode support
  • SEO optimization

Getting Started

Using Fumadocs is straightforward:

  1. Create your documentation content in MDX files
  2. Ability to use content collections
  3. Use Fumadocs components to enhance your docs
  4. Customize the theme and layout as needed

Customization Options

Fumadocs offers extensive customization:

  • Theming: Adjust colors, typography, and spacing
  • Layout: Modify sidebar, header, and footer components
  • Components: Create custom MDX components
  • Configuration: Fine-tune search, navigation, and more