Access it here
A modular and fully featured wiki powered by mdBook, GitHub Pages and pull-requests!
- No databases! Only static files—lightweight and fast to deploy
- Markdown-based content with full Git history and version control
- Offline capable—download the entire wiki and read it locally
- Custom theming with Rust-based mdBook preprocessing
- DMI Sprite support for game entity visualization
- Multiple preprocessors—admonitions, emoji codes, template expansion, and more
- Simple Git workflow—edit files directly or via GitHub web editor
- Rust & Cargo (for mdBook)
- Node.js (optional, for preprocessor scripts)
Install mdBook and dependencies:
cargo install mdbookBuild the static site:
mdbook buildThe compiled wiki will be in book/html/.
Serve the wiki locally with live reloading:
mdbook serveOpen your browser to http://localhost:3000 and changes will auto-refresh.
src/ # Markdown source files
├── SUMMARY.md # Navigation structure
├── index.md # Home page
├── guides/ # User guides
├── gamemodes/ # Game mode documentation
├── maps/ # Map information
├── rules/ # Game rules
└── images/ # Wiki images and sprites
theme/ # mdBook theme customization
├── head.hbs # HTML head injection (DMI sprites, scripts)
├── index.hbs # Main template
└── compiled/ # Generated CSS
scripts/ # Additional JavaScript
book.toml # mdBook configuration
- Fork & clone the repository
- Create a branch for your changes
- Edit markdown files in
src/ - Test locally with
mdbook serve - Commit & push, then open a pull request
See CONTRIBUTING.md for detailed guidelines.
Edit book.toml to modify:
- Theme—Default and dark theme settings
- Preprocessors—Admonitions, emoji codes, template expansion
- Additional CSS/JS—Custom styling and functionality
- Features—Syntax highlighting, MathJax support, etc.
The wiki uses several mdBook preprocessors:
- admonish—Note, warning, and info boxes
- emojicodes—Emoji shorthand support
- template—Template expansion in markdown
- embedify—Content embedding
The wiki must be served via HTTP (not file://). Use mdbook serve for local testing or host via GitHub Pages.
Ensure you have the latest mdBook version:
cargo install mdbook --upgradeClear the build cache and rebuild:
rm -rf book/
mdbook buildIcons made by Freepik and ultimatearm from www.flaticon.com
See LICENSE for details.