Welcome to Clarity

Clarity is a modern, feature-rich documentation platform built with Astro 5. It’s designed to help teams create beautiful, searchable, and maintainable documentation with minimal setup.

Why Clarity?

Built for Teams: Clarity provides authentication, role management, and collaboration features out of the box.

Developer-Friendly: Write documentation in Markdown, with full TypeScript support and hot reload during development.

Production-Ready: Includes OAuth authentication (Google & GitHub), full-text search, SEO optimization, and responsive design.

Customizable: Configure everything through a single clarity.config.ts file - from branding to feature toggles.

Key Features

• 🔍 Full-text search with keyboard shortcuts (⌘K)
• 🔐 OAuth authentication with Google and GitHub
• 📝 Active table of contents with scroll highlighting
• 🎨 Dark/light theme with system preference detection
• 💬 Feedback widget on every documentation page
• 🔗 GitHub integration for edit links and contributors
• 📊 Mermaid diagram support for visual documentation
• 🎯 SEO optimized with automatic sitemap generation
• 🧩 Advanced components (Callouts, Tabs, Code copying)
• 🗺️ Breadcrumb navigation for better UX
• ⚡ Lightning-fast static site generation

Quick Links

• Getting Started - Install and run Clarity
• Quick Start - Get up and running in minutes
• Configuration - Customize Clarity for your team
• Using Components - Learn about advanced features
• Authentication Setup - Configure OAuth providers
• Deployment - Deploy to production

Open Source

Clarity is open source and available on GitHub. Contributions, issues, and feature requests are welcome!

Next Steps

Ready to get started? Head over to the Getting Started guide to install Clarity and create your first documentation site.