Welcome to your documentation site — powered by Runir, a modern documentation platform with extended markdown support.
Welcome to your documentation site, powered by Runir — a modern, configurable documentation platform built for teams that want beautiful docs without the complexity.
Runir supports extended markdown components like this one. Write <Tip>, <Note>, <Warning>, and <Info> blocks directly in your markdown.
Everything you need to build world-class documentation.
Get up and running in under a minute.
Install and initialize Runir in your project:
npm install -g @fezcode/runir
runir init
Open runir.config.js and set your site name, navigation, and base path:
module.exports = {
name: "My Project Docs",
basePath: "/docs", // or "" for root
docsDir: "docs",
navigation: [
{
title: "Getting Started",
links: [
{ title: "Introduction", href: "/" },
],
},
],
};
Create markdown files in the docs/ directory. Use frontmatter for metadata:
---
title: My First Page
description: A brief description for search.
tags: [guide, tutorial]
---
# My First Page
Your content here.
runir dev
Open http://localhost:3000 and start writing.