Documentation

Build your documentation site using MDX.

TechShip includes a documentation site built using MDX.

Features

It comes with the following features out of the box:

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

How is it built

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

Components

Using React components in Mardown.

Code Blocks

Beautiful code blocks with syntax highlighting.

Style Guide

View a sample page with all the styles.

IntroductionComponents