Astrodex is an elite, monochromatic documentation framework engineered for developers who demand high-performance technical infrastructure. Built on Astro 5.x and Tailwind CSS v4, it provides a "Product-Level" UI for hosting complex documentation ecosystems with absolute speed, precision, and zero maintenance overhead.
Documentation is often the most neglected part of a product. Astrodex changes the narrative by treating documentation as a high-end software product. It’s not just a template; it's a static-first engine designed to scale from a single README to a massive enterprise hub.
- Infinite Scalability: Orchestrate multiple independent projects (CLI, API, SDKs) in one unified hub.
- Native Versioning: Parallel support for
v1.x,v2.x, andlegacywith automatic routing. - Obsidian Aesthetic: A premium, monochromatic design system that eliminates visual noise.
- Search Engine Dominance: Engineered for SEO with automatic sitemaps, semantic HTML, and metadata validation.
Manage independent project identities using the project.metadata.md manifest. Each project gets its own overview, maintainer list (Facepile), and version switcher.
- Stateful Sidebar: Remembers collapsed/expanded groups across sessions.
- Real-time Filter: Instant UI refinement as you type.
- Command Palette: Site-wide search via
Ctrl + Kwith pre-indexed results.
- Mermaid.js Diagrams: Native architecture and sequence visualization.
- Premium Code Blocks: Shiki-powered syntax highlighting with one-click copy.
- Admonitions: Semantic callouts for
Note,Warning, andDanger. - Intelligent Assets: Automatic WebP conversion and
medium-zoomlightboxes.
Create your repository using the GitHub Template or clone manually:
git clone https://github.com/antiantidev/astrodex.git
npm installnpm run devEngine accessible at http://localhost:4321.
Follow the Filesystem-as-API structure in src/content/docs/:
docs/
└── my-project/
├── project.metadata.md <-- Root Manifest
└── v1.0/ <-- Version Folder
├── introduction.md
└── configuration/ <-- Sidebar Category
└── setup.md
- Hub Identity: Edit
src/site.config.tsto define your brand, social links, and global SEO. - Visual Theme: Modify the
@themevariables insrc/styles/global.cssto rebrand the monochromatic palette. - Validation: All content is validated via Zod schemas in
src/content/config.ts.
Astrodex is optimized for edge distribution. Deploy to any static provider in seconds:
- GitHub Pages: Pre-configured workflow in
.github/workflows/deploy.yml. - Vercel / Netlify: Automatic detection and instant deployment.
We welcome contributions to the Astrodex Engine. Please see our Astrodex Manual for detailed architecture notes.
Licensed under the MIT License.
Built with absolute focus by Antiantidev.
If this engine powers your docs, consider giving it a ⭐.