https://github.com/getlumos/docs-lumos
Write once. Deploy Everywhere. | Official LUMOS documentation at lumos-lang.org
https://github.com/getlumos/docs-lumos
documentation lumos rust schema-language solana type-safety typescript vitepress
Last synced: 2 months ago
JSON representation
Write once. Deploy Everywhere. | Official LUMOS documentation at lumos-lang.org
- Host: GitHub
- URL: https://github.com/getlumos/docs-lumos
- Owner: getlumos
- Created: 2025-11-18T23:51:49.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2026-02-03T09:19:12.000Z (4 months ago)
- Last Synced: 2026-02-03T22:12:00.171Z (4 months ago)
- Topics: documentation, lumos, rust, schema-language, solana, type-safety, typescript, vitepress
- Language: JavaScript
- Homepage: https://docs.lumos-lang.org
- Size: 5.21 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# LUMOS Documentation
[](LICENSE-MIT)
[](https://starlight.astro.build)
Official documentation website for [LUMOS](https://github.com/getlumos/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](https://starlight.astro.build)
---
## 🚀 Quick Start
```bash
# 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](https://starlight.astro.build/)** - Documentation framework
- **[Astro](https://astro.build/)** - Static site generator
- **Deployed on:** Vercel
---
## 📝 Contributing
1. Fork the repo
2. Create a feature branch
3. Make your changes
4. Test locally with `npm run dev`
5. Submit a pull request
**Documentation Guidelines:**
- Use clear, concise language
- Include code examples
- Test all links
- Follow existing structure
---
## 🔗 Related Repos
- [**lumos**](https://github.com/getlumos/lumos) - Main repository (core + CLI)
- [**vscode-lumos**](https://github.com/getlumos/vscode-lumos) - VSCode extension
- [**awesome-lumos**](https://github.com/getlumos/awesome-lumos) - Community examples
---
## 📄 License
Dual-licensed under MIT OR Apache-2.0
---
**Built with ❤️ for the Solana community**