The official documentation for UnifiedHytale - the ultimate platform for Hytale mods, maps, resource packs, and server listings.
Live Site: docs.unifiedhytale.com
We welcome contributions from the community! Here's how you can help:
For small changes like typos or clarifications:
- Click "Edit on GitHub" on any documentation page
- Make your changes
- Submit a pull request
For new pages or significant changes:
- Fork this repository
- Create a new branch:
git checkout -b my-feature - Make your changes
- Test locally (see below)
- Submit a pull request
All documentation is written in MDX format. Files are located in content/docs/.
Each MDX file needs frontmatter:
---
title: Page Title
description: A brief description of the page content.
---You can use these built-in components:
<Callout type="info">
Helpful information
</Callout>
<Callout type="warn">
Warning message
</Callout>
<Cards>
<Card title="Title" href="/docs/page">
Description
</Card>
</Cards># Clone the repository
git clone https://github.com/UnifiedHytale/docs.git
cd docs
# Install dependencies
npm install
# or
bun install
# Start development server
npm run dev
# or
bun devOpen http://localhost:3000 to view the docs.
npm run build
npm run start├── content/
│ └── docs/ # MDX documentation files
├── public/ # Static assets
├── src/
│ ├── app/ # Next.js app router
│ ├── components/ # React components
│ ├── lib/ # Utilities and config
│ └── styles/ # Global styles
├── source.config.ts # Fumadocs MDX config
└── package.json
- Next.js - React framework
- Fumadocs - Documentation framework
- Tailwind CSS - Styling
- MDX - Markdown with React components
This project is licensed under the MIT License - see the LICENSE file for details.