The official documentation site for Dragonfly — a fast, lightweight Minecraft Bedrock Edition server written in Go.
- Framework: Next.js 16 with React 19
- Documentation: Fumadocs for MDX-based documentation
- Styling: Tailwind CSS 4 with Framer Motion animations
- Package Manager: Bun
- Bun (recommended) or Node.js 18+
# Clone the repository
git clone https://github.com/df-mc/docs.git
cd docs
# Install dependencies
bun install# Start the development server
bun run devOpen http://localhost:3000 in your browser.
# Build for production
bun run build
# Start the production server
bun run startdragonfly-docs/
├── app/ # Next.js app router pages
├── components/ # React components
├── content/
│ └── docs/ # Documentation content (MDX)
│ ├── changelogs/ # Version changelogs
│ ├── community/ # Community resources
│ ├── core-concepts/ # Core concepts & architecture
│ ├── getting-started/ # Quick start guides
│ ├── migration/ # Migration guides
│ ├── reference/ # API reference
│ ├── source/ # Source code documentation
│ └── tutorials/ # Step-by-step tutorials
├── lib/ # Utility functions
├── public/ # Static assets
└── static/ # Additional static files
Contributions are welcome! To contribute:
- Fork the repository
- Create a feature branch (
git checkout -b feature/my-feature) - Make your changes
- Commit your changes (
git commit -m 'Add some feature') - Push to the branch (
git push origin feature/my-feature) - Open a Pull Request
Documentation is written in MDX format. Create or edit files in the content/docs/ directory. Each page should include frontmatter:
---
title: Page Title
description: A brief description of the page
---
Your content here...| Command | Description |
|---|---|
bun run dev |
Start development server |
bun run build |
Build for production |
bun run start |
Start production server |
bun run lint |
Run ESLint |
bun run type-check |
Run TypeScript type checking |
This project is part of the Dragonfly ecosystem. See the main Dragonfly repository for license information.