Gollum logo

Gollum

A Git-based wiki with local editing, version history, and support for many markup formats

Open Source Alternative to
Repository activity
  • Stars14.3k
  • Forks1.6k
  • Open Issues91
gollum health score - Linux Foundation Insights
License

MIT

Languages
  • Ruby
  • JavaScript
  • Mustache
Gollum screenshot

About Gollum

Gollum is a simple wiki system built on top of Git. Each wiki is a Git repository of human-editable text or markup files, so pages can be organized in directories, edited in a local editor or through the web interface, and kept with images, PDFs, and headers or footers.

It supports Markdown and RDoc out of the box, with additional renderers for AsciiDoc, Creole, MediaWiki, Org, Pod, ReStructuredText, and Textile. Pages can use different markups, and features include diagram rendering with Mermaid or PlantUML, BibTeX and citation support, CriticMarkup annotations, mathematics via KaTeX or MathJax, macros, redirects, and an RSS feed of recent changes.

Gollum runs on Unix-like systems and Windows, with Ruby or JRuby, and on Windows it runs only with JRuby. It can be installed as a Ruby gem, run via Docker, or deployed as a Java WAR, and it can work with GitHub and GitLab wiki repositories locally. It is open source under the MIT license.

Key features

  • Wiki pages stored as a Git repository
  • Edit pages locally or in the built-in web interface
  • Markdown, RDoc, and other markup renderers
  • Mermaid and PlantUML diagram support
  • RSS feed of latest changes

Details

First released
2010
Platforms
Windows · macOS · Linux · Web
Deployment
self-hostable · docker
Storage
Git repository of text files
Runs on
Ruby · JRuby
License
MIT