Documentation

Build your documentation site using Contentlayer and MDX.


chameleon includes a documentation site built using Contentlayer and MDX.

Features

It comes with the following features out of the box:

  1. Write content using MDX.
  2. Transform and validate content using Contentlayer.
  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.

Contentlayer

Learn how to use MDX with Contentlayer.

View

Components

Using React components in Mardown.

View

Code Blocks

Beautiful code blocks with syntax highlighting.

View

Style Guide

View a sample page with all the styles.

View