Why Choose CelestialDocs?
Choosing a documentation system is critical—it affects how easily you can maintain docs, how intuitive navigation feels for readers, and how your documentation scales as you grow. Here’s why CelestialDocs stands out.
The Problem with Existing Solutions
Most documentation systems force you to choose:
- Simplicity vs. Power: Simple systems lack the flexibility for complex docs; powerful systems require extensive configuration
- Auto-Generation vs. Control: Auto-generated navigation is convenient but uncontrolled; manual navigation gives control but requires constant updates
- Single vs. Multiple Collections: Supporting multiple independent documentation systems is either impossible or requires separate deployments
CelestialDocs solves these tensions.
Our Solutions
1. Unified Three-Tier Hierarchy
Instead of limiting you to flat navigation or requiring deep nesting complexity, CelestialDocs provides:
- Entries: Individual pages
- Groups: Collections of entries
- Tabs: Top-level navigation contexts
This hierarchy scales naturally from simple docs (10 pages) to complex systems (1000+ pages).
2. Hybrid Generation
You’re not forced to choose. With hybrid mode:
- Pin 2-3 critical pages to always appear first
- Rest auto-discover alphabetically
- Update configuration once, never again
This is game-changing for growing documentation.
3. True Multi-Collection
One codebase, unlimited documentation systems:
systems: [
{ id: "docs", dir: "content/docs", route: "/docs" },
{ id: "api", dir: "content/api", route: "/api" },
{ id: "guides", dir: "content/guides", route: "/guides" },
];
Each collection is completely independent—different navigation, different configurations, same infrastructure.
Technical Advantages
Type Safety Throughout
Every configuration option is validated through TypeScript:
export const SIDEBAR_NAVIGATION: SidebarNavigation = {
docs: {
defaultTab: { label: "Learn", icon: "book" },
groups: [
// IDE autocomplete helps you here ✨
{ id: "features", label: "Features", autoGenerated: true },
],
},
};
Smart Label Derivation
Files become sidebar entries automatically with proper labels:
- File:
getting-started/installation.md - Label: “Installation” (automatic title-casing)
- Frontmatter override available when needed
Zero Configuration Auto-Discovery
// That's it. Files in the folder automatically appear.
{ id: "features", label: "Features", autoGenerated: true }
User Experience Benefits
Breadcrumb Navigation
Every page shows the navigation path. Users understand where they are and can click to navigate:
CelestialDocs > Navigation System > Tabs
Responsive Design
Works perfectly on phones, tablets, and desktops. Sidebar collapses appropriately.
Dark Mode Built-In
System-aware theme switching respects user preferences and persists across sessions.
Table of Contents
Auto-generated from page headings with active section highlighting.
Scalability
- Small Projects: Start simple with a single auto-generated group
- Growing Projects: Add curated groups, pin important pages with hybrid mode
- Enterprise: Multiple collections, deep nesting, complete type safety
- Multi-Product: Unlimited independent collections with one codebase
Ready to get started? Head to Getting Started