Clarity Docs
A premium documentation platform for teams
Built with Astro 5. Write documentation in Markdown with full TypeScript support.
OAuth authentication, full-text search, SEO optimization, and beautiful design out of the box.
Why most docs fail
Documentation decay is inevitable in most systems:
- • Docs live far from code (hard to keep in sync)
- • No clear ownership (everyone's responsibility = no one's)
- • Search doesn't help if you don't know what to search for
- • Wikis turn into information graveyards
Engineering teams resort to Slack threads and tribal knowledge.
Clarity treats documentation as a first-class product, not a support artifact.
Key Features
Full-Text Search
Lightning-fast search across all documentation with keyboard shortcuts (⌘K/Ctrl+K). Pre-indexed at build time for instant results. No server required.
OAuth Authentication
Built-in authentication with Google and GitHub. Protect sensitive documentation. Seamless login experience for your team.
Active Table of Contents
Scroll-highlighting navigation that tracks reading progress. Jump to any section instantly. Perfect for long technical documents.
Dark/Light Theme
Automatic system preference detection with manual toggle. Carefully designed color schemes for optimal readability in both modes.
GitHub Integration
Edit links on every page for quick fixes. Contributor badges showing authors. Breadcrumb navigation. Seamless Git workflow.
Advanced Components
Callouts (info/warning/danger/tip), Tabs, automatic code copying, Mermaid diagram support, and custom markdown components. Developer-friendly authoring.
Use Cases
Open Source Projects
Who: Maintainers of OSS libraries/tools
Problem: Need clear, searchable docs without maintaining infrastructure
Solution: Deploy Clarity to GitHub Pages or Vercel (free)
Outcome: Contributors find answers, fewer support issues
Internal Engineering Docs
Who: Platform teams at growing startups
Problem: Tribal knowledge scattered across Notion, Confluence, Slack
Solution: Centralize in Clarity with protected routes
Outcome: New hires onboard faster, less repeated questions
API Documentation
Who: Developer-facing product companies
Problem: API docs feel like an afterthought
Solution: Treat docs as product with Clarity
Outcome: Better developer experience = higher adoption
Getting Started
# Clone Clarity starter
git clone https://github.com/chanansystems/clarity-starter my-docs
cd my-docs
# Install dependencies
pnpm install
# Start dev server
pnpm dev
# Docs running at http://localhost:4321
# Create your first doc
# Edit src/content/docs/getting-started.md Next Steps:
Pricing
Free Plan
$0
- ✓ Unlimited public docs
- ✓ Instant search
- ✓ Syntax highlighting
- ✓ Dark mode
- ✓ Deploy anywhere
Team Plan
$39/month
- ✓ Everything in Free
- ✓ Protected documentation
- ✓ User authentication
- ✓ Analytics dashboard
- ✓ Team member management
- ✓ Priority support