Skip to content
Documentation

Introduction

Simple documentation, built on Next.js, Tailwind CSS, and shadcn/ui.

RDX turns folders and .md or .mdx files into a documentation website. Write your content, choose the features you need, and keep the framework's internal application out of your way.

The idea

  • A folder inside docs/ becomes a sidebar category.
  • A .md or .mdx file becomes a page.
  • rdx.config.ts controls branding, metadata, navigation, and optional features.
  • .rdx/ contains the generated Next.js application. You do not maintain it.

The foundation is Next.js + Tailwind CSS + shadcn/ui, using the Base UI variant. RDX adds the documentation layer: content indexing, Markdown integration, search, heading navigation, and optional version snapshots.

What is included?

FeatureHow to use it
File-based pages and categoriesAdd folders and Markdown or MDX files
Markdown, tables, and highlighted codeWrite standard Markdown
Code diffs and directory treesUse diff and folder fences
Image previewsClick an image written with standard Markdown
Callouts, Tabs, Accordion, and StepsUse the built-in Markdown components
Navbar, sidebar, theme, and page navigationIncluded in the shared layout
Local searchEnable search: true
Floating table of contentsEnable TOC: true
Optional homepageEnable homepage.enabled
Versioned documentationInstall and activate the versioning plugin

Start here

Follow Installation, then create your first page. The configuration reference explains the options without requiring you to edit generated Next.js files.

Keep it simple

Use ordinary Markdown for ordinary content. Add a component when it helps the reader, not to fill the page. Keep each page focused on a task, explain the steps, and include a working example.