Breadcrumbs

Documentation

Build your documentation site using Velite and MDX.


This site is a work in progress. If you see dummy text on a page, it means I'm still working on it.

NextKit includes a documentation site built using Velite and MDX.

Features

It comes with the following features out of the box:

  1. Write content using MDX.
  2. Transform and validate content using Velite.
  3. MDX components such as <Callout /> and <Card />.
  4. Support for table of contents.
  5. Custom navigation with prev and next pager.
  6. Beautiful code blocks using rehype-pretty-code.
  7. Syntax highlighting using shiki.
  8. Built-in search (in progress).
  9. Dark mode (in progress).

How is it built

Click on a section below to learn how the documentation site built.

Velite

Learn how to use MDX with Velite.

View

Components

Using React components in Markdown.

View

Code Blocks

Beautiful code blocks with syntax highlighting.

View

Style Guide

View a sample page with all the styles.

View