Quick Start

This guide will help you set up Unmint and create your first documentation page.

Prerequisites

Before you begin, make sure you have:

Node.js 18+ installed
npm or pnpm package manager
A code editor (VS Code recommended)

Installation

Clone the repository

Start by cloning the Unmint template:

git clone https://github.com/gregce/unmint.git my-docs
cd my-docs

Install dependencies

Install the required npm packages:

npm install

Start the development server

Launch the local development server:

npm run dev

Open http://localhost:3000 in your browser.

Create your first page

Add a new MDX file in content/docs/:

---
title: My First Page
description: A description of my page
---

# Hello World

This is my first documentation page!

Project Structure

Here's an overview of the key directories:

my-docs/
├── app/                    # Next.js app directory
│   ├── docs/              # Documentation routes
│   └── components/        # UI components
├── content/
│   └── docs/              # Your MDX documentation files
│       ├── index.mdx      # Homepage
│       └── meta.json      # Navigation structure
├── lib/
│   └── theme-config.ts    # Customize your theme here
└── public/                # Static assets

Edit content/docs/meta.json to configure your sidebar navigation:

{
  "title": "Documentation",
  "pages": [
    "index",
    "quickstart",
    "---Getting Started---",
    "installation",
    "configuration"
  ]
}

Info

Use "---Section Name---" to create section separators in your sidebar.

Next Steps

Learn Components

Explore all available MDX components

Customize Theme

Match your brand colors and styling