Skip to content

Commit e959d9b

Browse files
committed
feat: Initial LUMOS documentation site with Astro Starlight
- Set up Astro Starlight with LUMOS branding (purple/gold theme) - Created custom logo with illuminated rays design - Added custom CSS with LUMOS color palette and styling - Built documentation structure: - Getting Started (Introduction, Installation, Quick Start) - Guides (Type Mapping, Anchor Integration, Enum Support) - API Reference (CLI, Parser, Generators) - Examples (Gaming, NFT, DeFi, DAO, Token Vesting) - Homepage with hero section and feature cards - Configured for deployment to docs.lumos-lang.com Technology stack: - Astro Starlight (documentation framework) - Custom theme with purple (#9333EA) and gold (#FACC15) - Responsive design with dark mode - Zero vulnerabilities (367 packages audited)
1 parent 88cc17e commit e959d9b

File tree

9 files changed

+7520
-65
lines changed

9 files changed

+7520
-65
lines changed

README.md

Lines changed: 81 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,100 @@
1-
# Starlight Starter Kit: Basics
1+
# LUMOS Documentation
22

3-
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3+
Official documentation website for [LUMOS](https://github.com/getlumos/lumos) - Type-safe schema language for Solana development.
44

5-
```
6-
npm create astro@latest -- --template starlight
7-
```
5+
**Live Site:** https://docs.lumos-lang.com
6+
7+
Built with [Astro Starlight](https://starlight.astro.build)
88

9-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
9+
---
1010

11-
## 🚀 Project Structure
11+
## 🚀 Quick Start
1212

13-
Inside of your Astro + Starlight project, you'll see the following folders and files:
13+
```bash
14+
# Install dependencies
15+
npm install
1416

17+
# Start dev server
18+
npm run dev
19+
# Opens http://localhost:4321
20+
21+
# Build for production
22+
npm run build
23+
24+
# Preview production build
25+
npm run preview
1526
```
16-
.
17-
├── public/
27+
28+
---
29+
30+
## 📁 Structure
31+
32+
```
33+
docs-lumos/
1834
├── src/
19-
│ ├── assets/
2035
│ ├── content/
2136
│ │ └── docs/
22-
│ └── content.config.ts
23-
├── astro.config.mjs
24-
├── package.json
25-
└── tsconfig.json
37+
│ │ ├── getting-started/ # Installation, Quick Start
38+
│ │ ├── guides/ # Type Mapping, Anchor Integration
39+
│ │ ├── api/ # CLI, Parser, Generators
40+
│ │ └── examples/ # Real-world schemas
41+
│ ├── assets/ # Logo, images
42+
│ └── styles/
43+
│ └── custom.css # LUMOS branding (purple/gold)
44+
├── astro.config.mjs # Starlight configuration
45+
└── package.json
2646
```
2747

28-
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
48+
---
49+
50+
## 🎨 Branding
51+
52+
LUMOS uses a **purple & gold** color theme:
53+
54+
- **Primary:** `#9333EA` (Purple-600)
55+
- **Accent:** `#FACC15` (Gold-400)
56+
- **Background:** `#0F172A` (Dark slate)
57+
58+
Custom styles in `src/styles/custom.css`.
59+
60+
---
61+
62+
## 🛠️ Technology Stack
63+
64+
- **[Astro Starlight](https://starlight.astro.build/)** - Documentation framework
65+
- **[Astro](https://astro.build/)** - Static site generator
66+
- **Deployed on:** Vercel
67+
68+
---
69+
70+
## 📝 Contributing
71+
72+
1. Fork the repo
73+
2. Create a feature branch
74+
3. Make your changes
75+
4. Test locally with `npm run dev`
76+
5. Submit a pull request
77+
78+
**Documentation Guidelines:**
79+
- Use clear, concise language
80+
- Include code examples
81+
- Test all links
82+
- Follow existing structure
83+
84+
---
2985

30-
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
86+
## 🔗 Related Repos
3187

32-
Static assets, like favicons, can be placed in the `public/` directory.
88+
- [**lumos**](https://github.com/getlumos/lumos) - Main repository (core + CLI)
89+
- [**vscode-lumos**](https://github.com/getlumos/vscode-lumos) - VSCode extension
90+
- [**awesome-lumos**](https://github.com/getlumos/awesome-lumos) - Community examples
3391

34-
## 🧞 Commands
92+
---
3593

36-
All commands are run from the root of the project, from a terminal:
94+
## 📄 License
3795

38-
| Command | Action |
39-
| :------------------------ | :----------------------------------------------- |
40-
| `npm install` | Installs dependencies |
41-
| `npm run dev` | Starts local dev server at `localhost:4321` |
42-
| `npm run build` | Build your production site to `./dist/` |
43-
| `npm run preview` | Preview your build locally, before deploying |
44-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
45-
| `npm run astro -- --help` | Get help using the Astro CLI |
96+
Dual-licensed under MIT OR Apache-2.0
4697

47-
## 👀 Want to learn more?
98+
---
4899

49-
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
100+
**Built with ❤️ for the Solana community**

astro.config.mjs

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,64 @@ import starlight from '@astrojs/starlight';
44

55
// https://astro.build/config
66
export default defineConfig({
7+
site: 'https://docs.lumos-lang.com',
78
integrations: [
89
starlight({
9-
title: 'My Docs',
10-
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/withastro/starlight' }],
10+
title: 'LUMOS',
11+
description: 'Type-safe schema language for Solana development',
12+
logo: {
13+
src: './src/assets/logo.svg',
14+
},
15+
social: [
16+
{
17+
icon: 'github',
18+
label: 'GitHub',
19+
href: 'https://github.com/getlumos/lumos'
20+
},
21+
{
22+
icon: 'twitter',
23+
label: 'Twitter',
24+
href: 'https://twitter.com/getlumos'
25+
},
26+
],
27+
customCss: [
28+
'./src/styles/custom.css',
29+
],
1130
sidebar: [
31+
{
32+
label: 'Getting Started',
33+
items: [
34+
{ label: 'Introduction', slug: 'getting-started/introduction' },
35+
{ label: 'Installation', slug: 'getting-started/installation' },
36+
{ label: 'Quick Start', slug: 'getting-started/quick-start' },
37+
],
38+
},
1239
{
1340
label: 'Guides',
1441
items: [
15-
// Each item here is one entry in the navigation menu.
16-
{ label: 'Example Guide', slug: 'guides/example' },
42+
{ label: 'Type Mapping', slug: 'guides/type-mapping' },
43+
{ label: 'Anchor Integration', slug: 'guides/anchor-integration' },
44+
{ label: 'Enum Support', slug: 'guides/enum-support' },
45+
{ label: 'Migration Guide', slug: 'guides/migration-guide' },
46+
],
47+
},
48+
{
49+
label: 'API Reference',
50+
items: [
51+
{ label: 'CLI Commands', slug: 'api/cli-commands' },
52+
{ label: 'Parser', slug: 'api/parser' },
53+
{ label: 'Generators', slug: 'api/generators' },
1754
],
1855
},
1956
{
20-
label: 'Reference',
21-
autogenerate: { directory: 'reference' },
57+
label: 'Examples',
58+
items: [
59+
{ label: 'Gaming Platform', slug: 'examples/gaming' },
60+
{ label: 'NFT Marketplace', slug: 'examples/nft-marketplace' },
61+
{ label: 'DeFi Staking', slug: 'examples/defi-staking' },
62+
{ label: 'DAO Governance', slug: 'examples/dao-governance' },
63+
{ label: 'Token Vesting', slug: 'examples/token-vesting' },
64+
],
2265
},
2366
],
2467
}),

0 commit comments

Comments
 (0)