Official documentation website for YuKumo — a modern, lightweight, production-ready Lavalink v4 client built with Fumadocs and Next.js.
- Getting Started — build a music bot with YuKumo in minutes
- API Reference — comprehensive reference for every public export
- Plugin Development — extend YuKumo with lifecycle hooks
- Node Deployment — production Lavalink v4 setup
- Migration Guide — upgrade from Lavalink v3 clients
- FAQ — common questions and troubleshooting
Prerequisites: Node.js 20.9+ (or Bun 1.0+) and npm.
npm install
npm run devOpen http://localhost:3000 in your browser.
| Script | Description |
|---|---|
npm run dev |
Start the development server |
npm run build |
Create an optimized production build |
npm run start |
Serve the production build |
npm run lint |
Lint and format-check with Biome |
npm run format |
Auto-format the codebase with Biome |
npm run types:check |
Generate route types and type-check |
src/
├── app/
│ ├── (home)/ # Landing page
│ └── docs/ # Documentation layout and pages
├── components/ # MDX component registry
└── lib/ # Content source and shared config
content/
└── docs/ # MDX documentation source
.github/
├── workflows/ # CI pipeline
└── ISSUE_TEMPLATE/ # Issue forms
Documentation is written in MDX and lives in content/docs. See CONTRIBUTING.md for the full guide, conventions, and workflow.
Contributions are welcome! Read the contribution guide to get started.
If you discover a security vulnerability, please follow the disclosure steps in SECURITY.md.
MIT © Nex-Devz