Getting started
Local Environment
Installing prerequisites
Open PowerShell as Administrator and run these commands to set up your environment using Chocolatey:
# Download and install Chocolatey (Windows Package Manager):
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
# Install Git for version control:
choco install git -y
# Install Node.js (LTS version recommended for VitePress):
choco install nodejs -y
# Enable pnpm via Corepack:
corepack enable pnpm
# Verify installations:
git -v
node -v
pnpm -vIcons & Visuals
HyDocs utilizes Iconify to maintain a clean, high-performance interface. You can browse millions of icons at Icones.
Implementation Rules
| Section | Style | Example |
|---|---|---|
| In-line | :package-icon: | :mdi-minecraft: |
| Button | :i-package-icon: | :i-simple-icons-hypixel: |
| Typescript | CSS Class | "<span class=""i-mdi:sword""></span>" |
| Index.md | SVG | Raw SVG Code |
Custom Aliases
Frequently used Hypixel-related icons (like SkyBlock skills or ranks) are shortened using Aliases in the Ssheet. These work in-line for rapid documentation.
Default Style
Twitter Emoji (Twemoji) is the default set for HyDocs. For standard emojis, you don't need to specify a package name—just the icon name.
Managing Icon Packs
| Action | Command |
|---|---|
| Add New Pack | pnpm add -D @iconify-json/<packname> |
| Remove Pack | pnpm remove @iconify-json/<packname> |
Note: After installing a pack, you must register it in docs\.vitepress\configs\markdown\emoji.ts.
Contribution Rules
Consistency: Follow the tab order established in the sheet. Spacing: No spaces between icons at the start of a resource entry. URL Structure: Icons follow the main URL, then the source link (GitHub/Guide), then utility buttons (Wiki, Calculator). Interactive Elements: Maintain a single space between buttons to ensure mobile-friendly clicking. Tooltips: Always place tooltip keys at the absolute end of the line.
Sheet (Icon Shortcuts)
| Icon | Code | Description |
|---|---|---|
:s: | Featured Resource / Essential | |
:e: | Mod / Extension | |
:n: | Nightly / Alpha Build | |
:feed: | Feedback / Bug Report | |
:yes: | Yes / Supported | |
:no: | No / Unavailable | |
:global: | Multilingual Support | |
:alt: | Alternative Version | |
:help: | Help / Docs / Guides | |
:more: | More Info / Related |
Tooltips
Tooltips provide technical context without cluttering the UI. Configuration is handled in docs\.vitepress\configs\markdown\index.ts
// Entry Example
skyblock_weight: {
title: "Senither/Lily Weight",
icon: "i-mdi-weight-gram",
content: "Calculates player progression based on skills and slayer."
}Inline Tooltips
For quick, one-off information, use the inline syntax: ^[Display Text](Information that appears on hover)