mirror of
https://github.com/luxfi/docs-template.git
synced 2026-10-30 16:58:41 +00:00
zeekay
dc39f33937
Reusable documentation template for Lux Network projects. Features: - Fumadocs UI with Next.js 15 - Dark mode with system preference - Pre-configured social links (Lux, Discord, X, Warpcast) - SITE_CONFIG and DOCS_CONFIG for easy customization - @luxfi/logo integration - Tailwind CSS with typography plugin Usage: 1. Copy template to new directory 2. Edit SITE_CONFIG in app/layout.tsx 3. Edit DOCS_CONFIG in app/docs/layout.tsx 4. Add MDX content in content/docs/ 5. pnpm dev
118 lines
2.2 KiB
Plaintext
118 lines
2.2 KiB
Plaintext
---
|
|
title: Welcome
|
|
description: Documentation template for Lux Network projects
|
|
---
|
|
|
|
# Welcome to the Docs Template
|
|
|
|
This is a documentation template for Lux Network projects. Fork this repository and customize it for your project.
|
|
|
|
## Features
|
|
|
|
- **Dark Mode**: Automatic theme switching with system preference support
|
|
- **Fast**: Built with Next.js and optimized for performance
|
|
- **Searchable**: Built-in search functionality
|
|
- **Responsive**: Works on all device sizes
|
|
- **Customizable**: Easy to configure branding and content
|
|
|
|
## Getting Started
|
|
|
|
### 1. Fork this template
|
|
|
|
```bash
|
|
git clone https://github.com/luxfi/docs-template my-docs
|
|
cd my-docs
|
|
```
|
|
|
|
### 2. Install dependencies
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
### 3. Configure your site
|
|
|
|
Edit the configuration in these files:
|
|
|
|
- `app/layout.tsx` - Site metadata (name, description, URL)
|
|
- `app/docs/layout.tsx` - Sidebar config (GitHub, socials, footer links)
|
|
- `public/favicon.svg` - Your favicon
|
|
- `public/og.png` - Open Graph image
|
|
|
|
### 4. Add your content
|
|
|
|
Create MDX files in `content/docs/`:
|
|
|
|
```
|
|
content/docs/
|
|
├── index.mdx # Home page
|
|
├── getting-started.mdx
|
|
├── api/
|
|
│ ├── index.mdx
|
|
│ └── endpoints.mdx
|
|
└── guides/
|
|
└── example.mdx
|
|
```
|
|
|
|
### 5. Run locally
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Visit [http://localhost:3003](http://localhost:3003)
|
|
|
|
## Configuration
|
|
|
|
### Site Metadata
|
|
|
|
In `app/layout.tsx`:
|
|
|
|
```typescript
|
|
const SITE_CONFIG = {
|
|
name: 'Your Project Name',
|
|
description: 'Your project description',
|
|
url: 'https://docs.yourproject.com',
|
|
keywords: ['keyword1', 'keyword2'],
|
|
}
|
|
```
|
|
|
|
### Sidebar & Social Links
|
|
|
|
In `app/docs/layout.tsx`:
|
|
|
|
```typescript
|
|
const DOCS_CONFIG = {
|
|
name: 'Your Project Name',
|
|
github: 'https://github.com/your-org/your-repo',
|
|
socials: {
|
|
website: 'https://yourproject.com',
|
|
discord: 'https://discord.gg/your-server',
|
|
twitter: 'https://x.com/your-handle',
|
|
warpcast: 'https://warpcast.com/your-handle',
|
|
},
|
|
footerLinks: [
|
|
{ text: 'View on GitHub', url: '...', icon: 'github' },
|
|
],
|
|
}
|
|
```
|
|
|
|
## Deployment
|
|
|
|
### Vercel (Recommended)
|
|
|
|
1. Push to GitHub
|
|
2. Import in Vercel
|
|
3. Deploy automatically
|
|
|
|
### Static Export
|
|
|
|
```bash
|
|
pnpm build
|
|
# Output in `out/` directory
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|