🎉 Welcome

Start your DocuBook journey with key features like CLI tooling, prebuilt navigation trees, performance caching, and rich Markdown components.

Welcome to DocuBook! This site is built to help you create beautiful, fast, and maintainable documentation with minimal setup.

CLI Tooling

Scaffold pages, generate navigation trees, and manage your docs with a simple command line interface.

Prebuilt Navigation

Automatically build a navigation tree during builds for reliable sidebars and fast page loads.

High Performance

MDX compilation cache + Static Site Generation to reduce repeated work and speed up build times.

Markdown Components

Use ready-made MDX components like cards, tabs, accordions, and more to enrich your docs.

Getting Started

Goes start here to get started with DocuBook.

Introduction

This section provides an overview of DocuBook.

Installation

Installation guide for our application.

Quick Start Guide

Get up and running with DocuBook in minutes with this comprehensive guide

Format text

Format text in your docs with Markdown formatting like headings, bold, italic, links, blockquotes and other inline styling options in MDX.

Frontmatter

How to write frontmatter for metadata available in DocuBook

Theme Colors

Color system used in DocuBook for styling UI elements

Search

Several types of search components based on props

Components

a collection of components ready to be used for markdown.

Accordion

A component used to create collapsible content that can be hidden and shown again.

Accordion Group

for writing multiple accordions and grouping them together

Button

A component used to create buttons that can be used to trigger actions or navigate to other pages.

Cards

A component used to create cards that can be used to display content in a compact and organized way.

Card Group

A component used to create card groups that can be used to display multiple cards in a compact and organized way.

Code Block

A component used to display code snippets with optional line numbering and line highlighting.

File Tree

A customizable file tree component for displaying hierarchical file structures in your documentation.

Image

A component used to display images in Markdown.

Keyboard

Display keyboard keys with platform-specific styling for Windows and macOS.

Link

A component used to create links that can be used to navigate to other pages.

Note

A component used to display different types of messages such as general notes, warnings, or success notifications.

Release Note

The Release Note component makes it easy for you to write updates for each version of your application.

Stepper

A component used to display step-by-step instructions directly within the markdown render.

Tabs

Organize content into multiple sections with switchable tabs.

Tooltips

A component used to display additional information when hovering over a word or phrase.

Tables

Organize your data in style with GitHub-flavored tables.

Youtube

A component used to embed YouTube videos directly into your documentation.

Custom Components

How to create and register custom MDX components with the current setup.

Edit this page

Last updated May 4, 2026