LUMOS Documentation
December 7, 2025 · View on GitHub
Official documentation website for LUMOS - Type-safe schema language for Solana development.
Live Site: https://docs.lumos-lang.org
What is LUMOS?
LUMOS is a powerful code generation framework that bridges TypeScript and Rust for Solana development. Write your data structures once in .lumos syntax, and automatically generate production-ready code for both languages with guaranteed Borsh serialization compatibility.
Stop writing the same types twice. Start building faster.
Built with Astro Starlight
🚀 Quick Start
# Install dependencies
npm install
# Start dev server
npm run dev
# Opens http://localhost:4321
# Build for production
npm run build
# Preview production build
npm run preview
📁 Structure
docs-lumos/
├── src/
│ ├── content/
│ │ └── docs/
│ │ ├── getting-started/ # Installation, Quick Start
│ │ ├── guides/ # Type Mapping, Anchor Integration
│ │ ├── api/ # CLI, Parser, Generators
│ │ └── examples/ # Real-world schemas
│ ├── assets/ # Logo, images
│ └── styles/
│ └── custom.css # LUMOS branding (purple/gold)
├── astro.config.mjs # Starlight configuration
└── package.json
🎨 Branding
LUMOS uses a purple & gold color theme:
- Primary:
#9333EA(Purple-600) - Accent:
#FACC15(Gold-400) - Background:
#0F172A(Dark slate)
Custom styles in src/styles/custom.css.
🛠️ Technology Stack
- Astro Starlight - Documentation framework
- Astro - Static site generator
- Deployed on: Vercel
📝 Contributing
- Fork the repo
- Create a feature branch
- Make your changes
- Test locally with
npm run dev - Submit a pull request
Documentation Guidelines:
- Use clear, concise language
- Include code examples
- Test all links
- Follow existing structure
🔗 Related Repos
- lumos - Main repository (core + CLI)
- vscode-lumos - VSCode extension
- awesome-lumos - Community examples
📄 License
Dual-licensed under MIT OR Apache-2.0
Built with ❤️ for the Solana community