Runir Docs

Get your documentation site running locally in under a minute.

Quick Start

Get your documentation site running locally in under a minute.

Prerequisites

  • Node.js 18 or later
  • npm, yarn, or pnpm

Installation

npm install -g @fezcode/runir
runir init
runir dev
npx @fezcode/runir init
npx @fezcode/runir dev

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

The dev server automatically rebuilds the search index when you start it. For production, run runir build to generate a static build in the out/ directory.

Project structure

After running runir init, your project will have:

my-project/
├── runir.config.js    # Site configuration
└── docs/              # Your markdown files
    ├── index.md       # Homepage
    └── guide.md       # Other pages

Next steps