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
58 lines
894 B
Plaintext
58 lines
894 B
Plaintext
---
|
|
title: Getting Started
|
|
description: Quick start guide for your documentation
|
|
---
|
|
|
|
# Getting Started
|
|
|
|
This is an example page to demonstrate the documentation structure.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
## Development
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
Your docs will be available at [http://localhost:3003](http://localhost:3003).
|
|
|
|
## Adding Pages
|
|
|
|
Create new pages by adding `.mdx` files in the `content/docs/` directory:
|
|
|
|
```mdx
|
|
---
|
|
title: My New Page
|
|
description: Description for SEO
|
|
---
|
|
|
|
# My New Page
|
|
|
|
Content goes here...
|
|
```
|
|
|
|
Then add the page to `content/docs/meta.json`:
|
|
|
|
```json
|
|
{
|
|
"pages": [
|
|
"index",
|
|
"my-new-page"
|
|
]
|
|
}
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
- Customize `app/layout.tsx` with your site metadata
|
|
- Update `app/docs/layout.tsx` with your GitHub and social links
|
|
- Replace the favicon and OG image in `public/`
|
|
- Add your documentation content
|