What is ReviteDocs?
ReviteDocs is a modern documentation generator that combines the simplicity of markdown with the power of React components. Built on Vite for lightning-fast development and optimized production builds.
Features
- π Markdown-first - Write docs in Markdown/MDX with full GFM support
- β‘ Vite-powered - Instant HMR, fast builds, and modern tooling
- π¨ React components - Use React components directly in your docs
- π Full-text search - Built-in Pagefind search, works offline
- π Dark mode - Automatic theme switching
- π± Mobile-friendly - Responsive design out of the box
- πΊοΈ SEO ready - Automatic sitemap and meta tags
- π€ AI-friendly - Generates llms.txt for AI assistants
Quick Start
# Install
npm install revitedocs
# Create docs
mkdir docs && cd docs
revitedocs init
# Start writing
npm run dev
Why ReviteDocs?
- React-based - Build with the ecosystem you know
- Blazing fast - Powered by Vite for instant dev and optimized builds
- MDX support - Use React components directly in markdown
- Offline search - Built-in Pagefind for fast, client-side search
- Lightweight - ~50KB bundle, no heavy dependencies
Get Started
Ready to build beautiful documentation?
- Installation Guide - Set up ReviteDocs in 5 minutes
- Quick Start - Create your first docs site
- Configuration - Customize your site