Roguebasin is a Jekyll-powered GitHub Pages backup of the RogueBasin wiki, the community knowledge base for roguelike game developers.
What is Roguebasin?
Roguebasin is a repository that mirrors the content of RogueBasin.com by storing the wiki as Markdown files and publishing them as a static site. It runs on GitHub Pages using the git-wiki-theme for Jekyll, turning a plain Markdown repository into a browsable wiki. The project is a work in progress and is not affiliated with the original RogueBasin site; it exists to preserve the content and allow community contributions.
Key Features
- Git-wiki-theme — the site uses the git-wiki-theme for Jekyll, which converts Markdown pages into a navigable wiki site.
- GitHub Pages hosting — the wiki is automatically published at chizaruu.github.io/roguebasin, with no separate web server required.
- Offline access — because all content is plain Markdown, cloning the repository lets you read the entire wiki offline with any Markdown reader.
- Community contributions — you can submit a pull request to add or update articles, or open an issue to report errors on the current site.
- Project status tracking — the repository displays badges for website status, open milestones, issues, and pull requests, giving a quick overview of progress.
- Focused content scope — the repository's topic tags include 'roguelike' and 'wiki', reflecting its role as a backup of roguelike development documentation.
Who is it for?
- Roguelike developers who want a local copy of RogueBasin's documentation for offline reference while working on games.
- Wiki maintainers who want to help preserve and improve the backup by submitting pull requests with edits or new content.
- Jekyll users who want a real example of a git-wiki-theme project that renders a Markdown repository into a published wiki on GitHub Pages.
Use cases
- Offline reference lookup: clone the repository and search through the Markdown files without needing an internet connection.
- Community documentation updates: contribute fixes or new articles by opening a pull request, following standard GitHub workflows.
- Static site learning: study how a Jekyll project with git-wiki-theme is structured and deployed through GitHub Pages.
How does Roguebasin work?
The repository stores wiki pages as Markdown files. When changes are pushed to GitHub, GitHub Pages runs Jekyll to build the site with the git-wiki-theme, producing static HTML. Users can visit the live site or clone the repo and open the Markdown files in any compatible reader.
Pros and cons
- Pros: free to use and read, portable Markdown format, and open to community contributions.
- Cons: the project is explicitly a work in progress and is not affiliated with the original RogueBasin, so some content may be incomplete or behind the live wiki.
FAQ
Is Roguebasin free?
Yes. The repository is hosted on GitHub and the site is served via GitHub Pages at no cost to users.
Can I read Roguebasin offline?
Yes. Clone the repository and open the Markdown files with any Markdown reader; no internet connection is needed.
How can I contribute to Roguebasin?
Submit a pull request with cool updates or additions to the wiki content, or open an issue to report any mistakes you spot.
Is Roguebasin the official RogueBasin?
No. It is an independent backup repository and is not affiliated with the original RogueBasin website.
What technology powers Roguebasin?
It uses the git-wiki-theme for Jekyll, and is deployed automatically on GitHub Pages.
