Logo

Getting Started

IntroductionInstallationQuick Start
Logo
DocumentationAPI ReferenceChangelog

Getting Started

Introduction

Welcome to Docs Kit - A comprehensive documentation template built with Next.js, Chakra UI, and OpenAPI integration

Introduction

Welcome to Docs Kit, a modern, feature-rich documentation template designed for building beautiful, interactive documentation sites. Built with cutting-edge technologies like Next.js 15, Chakra UI v3, and seamless OpenAPI integration.

Quick Start

Installation

Get started with Docs Kit in minutes. Install dependencies and run locally.

Configuration

Configure navigation, colors, and customize your documentation site.

Components

Explore MDX components for creating rich, interactive documentation.

Core Features

MDX-Powered Content

Write documentation in Markdown with JSX components. Full type-safety with Velite integration and automatic validation.

Interactive API Docs

Auto-generated API documentation from OpenAPI specs with "Try It" functionality and code examples in 7+ languages.

Beautiful UI

Built with Chakra UI v3 featuring 10 color palettes, dark mode, and responsive design.

Full-Text Search

Fast, client-side search powered by FlexSearch with keyboard shortcuts (⌘K).

What You Can Build

Product Documentation

Create comprehensive user guides, tutorials, and troubleshooting documentation.

API Documentation

Build interactive API references with authentication guides and request/response examples.

Developer Portals

Complete developer experience with SDK guides, integration tutorials, and code samples.

Technical Guides

Step-by-step tutorials, configuration docs, and architecture documentation.

Technology Stack

Built with modern, production-ready technologies:

  • Next.js 15 - React framework with App Router
  • Chakra UI v3 - Modern, accessible component library
  • TypeScript - Full type safety across the codebase
  • Velite - Type-safe content compilation
  • Shiki - Beautiful syntax highlighting
  • FlexSearch - Fast full-text search

What Makes Docs Kit Different?

Content-First Approach

Write documentation in simple Markdown while having access to powerful React components when needed. No complex setup required - just create MDX files and the template handles the rest.

True Interactive API Docs

Unlike static API documentation, Docs Kit allows users to execute real API requests directly from the documentation. Test endpoints, view responses, and debug - all without leaving the docs.

Developer-Friendly

Built by developers, for developers. Type-safe configuration, hot reload, component reusability, and a clean, maintainable codebase.

Production-Ready

Not just a template - a complete documentation solution. Optimized performance, SEO-friendly, accessible, and ready to deploy.

Next Steps

1

Installation

Follow the installation guide to set up Docs Kit locally.

2

Quick Start

Read the quick start guide to create your first documentation page.

3

Configuration

Learn how to configure navigation, colors, and site settings.

4

Components

Explore the MDX components available for rich content.


Ready to get started? Head over to the Installation Guide to begin building your documentation site.

Built with Chakra UI

On this page
IntroductionQuick StartCore FeaturesWhat You Can BuildTechnology StackWhat Makes Docs Kit Different?Next Steps