Skip to content

Gurge44/ehr-wiki-deploy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

204 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

EHR Wiki

Official Documentation for Endless Host Roles

Live Site GitHub Discord

Comprehensive documentation for the largest Host-Only Among Us mod with 450+ roles, 16 game modes and Endless customisation

EHR Wiki Preview

Built with Astro Starlight Deployed on Netlify License

🌟 About

This repository powers the EHR Wiki - a comprehensive documentation site for Endless Host Roles. Built with modern web technologies, it provides:

  • Detailed Guides β€” Installation, setup, and gameplay tutorials
  • Role Encyclopedia β€” Complete descriptions of 450+ unique roles
  • Command Reference β€” Full documentation of chat commands
  • Configuration Docs β€” In-depth settings and customization options
  • Game Mode Guides β€” Strategies for all 16 game modes

πŸ› οΈ Tech Stack

Astro
Astro
Web Framework
Starlight
Starlight
Docs Theme
Netlify
Netlify
Hosting

πŸš€ Quick Start

Prerequisites

Node.js npm pnpm

Installation & Development

# Clone the repository
git clone https://github.com/Gurge44/ehr-wiki.git
cd ehr-wiki

# Install dependencies
npm install
# or
pnpm install

# Start development server
npm run dev

Open http://localhost:4321 in your browser

Build for Production

# Build the site
npm run build

# Preview production build locally
npm run preview

πŸ“‚ Project Structure

ehr-wiki-deploy/
β”‚
β”œβ”€β”€ public/              # Static assets (images, icons, fonts)
β”‚   └── ehr_wiki.png
β”‚
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ content/
β”‚   β”‚   β”œβ”€β”€ docs/       # Documentation pages (Markdown/MDX)
β”‚   β”‚   β”‚   β”œβ”€β”€ guides/
β”‚   β”‚   β”‚   β”œβ”€β”€ roles/
β”‚   β”‚   β”‚   β”œβ”€β”€ settings/
β”‚   β”‚   β”‚   └── ...
β”‚   β”‚   └── config.ts   # Starlight configuration
β”‚   β”‚
β”‚   └── assets/         # Optimized images & assets
β”‚
β”œβ”€β”€ astro.config.mjs     # Astro configuration
β”œβ”€β”€ package.json
└── README.md

🀝 Contributing

We love contributions! Whether you're fixing typos, adding new guides, or improving existing documentation, your help is appreciated.

Documentation Updates

  1. Fork this repository
  2. Create a new branch
    git checkout -b improve-docs
  3. Edit the relevant .md or .mdx files in src/content/docs/
  4. Commit your changes
    git commit -m 'Update role descriptions'
  5. Push to your branch
    git push origin improve-docs
  6. Open a Pull Request

Adding New Pages

Simply create new .md files in the appropriate directory under src/content/docs/. Starlight will automatically:

  • Add them to the navigation
  • Generate the sidebar
  • Handle routing

Reporting Issues

Found a problem? Open an issue and include:

  • What's wrong or outdated
  • Which page it's on
  • Suggested correction (if applicable)

πŸš€ Deployment

The site is automatically deployed to Netlify when changes are pushed to the main branch.

Netlify Status

πŸ“œ License

Copyright (c) 2025, Gurge44
Licensed under the BSD 4-Clause License

See LICENSE for full details.

πŸ’– Support

Need help?

Discord GitHub Issues


⭐ Star this repo if you find it helpful!

Made with ❀️ by the EHR Community

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6