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

Fork this template

git clone https://github.com/luxfi/docs-template my-docs
cd my-docs

Install dependencies

pnpm install

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

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

Run locally

pnpm dev

Visit http://localhost:3003

Configuration

Site Metadata

In app/layout.tsx:

const SITE_CONFIG = {
  name: 'Your Project Name',
  description: 'Your project description',
  url: 'https://docs.yourproject.com',
  keywords: ['keyword1', 'keyword2'],
}

In app/docs/layout.tsx:

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)

Push to GitHub
Import in Vercel
Deploy automatically

Static Export

pnpm build
# Output in `out/` directory

License

MIT

Welcome

On this page