Installation

Prerequisites

You need Bun v1.0 or later installed on your system.

# Install Bun (macOS / Linux)
curl -fsSL https://bun.sh/install | bash

Clone the template

git clone https://github.com/Nu11ified/docs-template my-docs
cd my-docs

Install dependencies

bun install

Start the dev server

bun run dev

Your site is now running at http://localhost:3000. The dev server watches for file changes and automatically reloads.

Build for production

To create a production build:

bun run build

This runs three steps:

  1. build:content — Compiles all MDX files into the manifest
  2. build:client — Bundles client-side JavaScript (search, sidebar, theme toggle)
  3. build:css — Processes Tailwind CSS

Then start the production server:

bun run start

Project scripts

ScriptDescription
bun run devStart development server with hot reload
bun run buildBuild content, client JS, and CSS for production
bun run startStart production server
bun run build:contentCompile MDX files only
bun run build:clientBundle client-side JS only
bun run build:cssBuild Tailwind CSS only