|
| 1 | +# Dragonfly Documentation |
| 2 | + |
| 3 | +The official documentation site for [Dragonfly](https://github.com/df-mc/dragonfly) — a fast, lightweight Minecraft Bedrock Edition server written in Go. |
| 4 | + |
| 5 | +## Tech Stack |
| 6 | + |
| 7 | +- **Framework**: [Next.js 16](https://nextjs.org/) with React 19 |
| 8 | +- **Documentation**: [Fumadocs](https://fumadocs.vercel.app/) for MDX-based documentation |
| 9 | +- **Styling**: Tailwind CSS 4 with Framer Motion animations |
| 10 | +- **Package Manager**: [Bun](https://bun.sh/) |
| 11 | + |
| 12 | +## Getting Started |
| 13 | + |
| 14 | +### Prerequisites |
| 15 | + |
| 16 | +- [Bun](https://bun.sh/) (recommended) or Node.js 18+ |
| 17 | + |
| 18 | +### Installation |
| 19 | + |
| 20 | +```bash |
| 21 | +# Clone the repository |
| 22 | +git clone https://github.com/df-mc/docs.git |
| 23 | +cd docs |
| 24 | + |
| 25 | +# Install dependencies |
| 26 | +bun install |
| 27 | +``` |
| 28 | + |
| 29 | +### Development |
| 30 | + |
| 31 | +```bash |
| 32 | +# Start the development server |
| 33 | +bun run dev |
| 34 | +``` |
| 35 | + |
| 36 | +Open [http://localhost:3000](http://localhost:3000) in your browser. |
| 37 | + |
| 38 | +### Build |
| 39 | + |
| 40 | +```bash |
| 41 | +# Build for production |
| 42 | +bun run build |
| 43 | + |
| 44 | +# Start the production server |
| 45 | +bun run start |
| 46 | +``` |
| 47 | + |
| 48 | +## Project Structure |
| 49 | + |
| 50 | +``` |
| 51 | +dragonfly-docs/ |
| 52 | +├── app/ # Next.js app router pages |
| 53 | +├── components/ # React components |
| 54 | +├── content/ |
| 55 | +│ └── docs/ # Documentation content (MDX) |
| 56 | +│ ├── changelogs/ # Version changelogs |
| 57 | +│ ├── community/ # Community resources |
| 58 | +│ ├── core-concepts/ # Core concepts & architecture |
| 59 | +│ ├── getting-started/ # Quick start guides |
| 60 | +│ ├── migration/ # Migration guides |
| 61 | +│ ├── reference/ # API reference |
| 62 | +│ ├── source/ # Source code documentation |
| 63 | +│ └── tutorials/ # Step-by-step tutorials |
| 64 | +├── lib/ # Utility functions |
| 65 | +├── public/ # Static assets |
| 66 | +└── static/ # Additional static files |
| 67 | +``` |
| 68 | + |
| 69 | +## Contributing |
| 70 | + |
| 71 | +Contributions are welcome! To contribute: |
| 72 | + |
| 73 | +1. Fork the repository |
| 74 | +2. Create a feature branch (`git checkout -b feature/my-feature`) |
| 75 | +3. Make your changes |
| 76 | +4. Commit your changes (`git commit -m 'Add some feature'`) |
| 77 | +5. Push to the branch (`git push origin feature/my-feature`) |
| 78 | +6. Open a Pull Request |
| 79 | + |
| 80 | +### Writing Documentation |
| 81 | + |
| 82 | +Documentation is written in MDX format. Create or edit files in the `content/docs/` directory. Each page should include frontmatter: |
| 83 | + |
| 84 | +```mdx |
| 85 | +--- |
| 86 | +title: Page Title |
| 87 | +description: A brief description of the page |
| 88 | +--- |
| 89 | + |
| 90 | +Your content here... |
| 91 | +``` |
| 92 | + |
| 93 | +## Scripts |
| 94 | + |
| 95 | +| Command | Description | |
| 96 | +|---------|-------------| |
| 97 | +| `bun run dev` | Start development server | |
| 98 | +| `bun run build` | Build for production | |
| 99 | +| `bun run start` | Start production server | |
| 100 | +| `bun run lint` | Run ESLint | |
| 101 | +| `bun run type-check` | Run TypeScript type checking | |
| 102 | + |
| 103 | +## License |
| 104 | + |
| 105 | +This project is part of the Dragonfly ecosystem. See the main [Dragonfly repository](https://github.com/df-mc/dragonfly) for license information. |
0 commit comments