https://github.com/gollum/gollum Skip to content Sign up * Why GitHub? Features - + Mobile - + Actions - + Codespaces - + Packages - + Security - + Code review - + Issues - + Integrations - + GitHub Sponsors - + Customer stories- * Team * Enterprise * Explore + Explore GitHub - Learn and contribute + Topics - + Collections - + Trending - + Learning Lab - + Open source guides - Connect with others + The ReadME Project - + Events - + Community forum - + GitHub Education - + GitHub Stars program - * Marketplace * Pricing Plans - + Compare plans - + Contact Sales - + Education - [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} gollum / gollum Public * Notifications * Star 11.7k * Fork 1.6k A simple, Git-powered wiki with a sweet API and local frontend. MIT License 11.7k stars 1.6k forks Star Notifications * Code * Issues 38 * Pull requests 6 * Discussions * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 10 branches 88 tags Code Latest commit @beporter beporter Allow for overriding only specific Mustache templates/ partials. (#1719) ... 7517389 Sep 7, 2021 Allow for overriding only specific Mustache templates/partials. (# 1719) * Allow for overriding only specific templates/partials. Resolves #1450. 7517389 Git stats * 2,345 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github Create release.yml (#1760) Sep 6, 2021 bin Allow for overriding only specific Mustache templates/partials. (# 1719) Sep 7, 2021 contrib contrib/automation/gollum-post: A script to post files to Gollum in a... Feb 13, 2021 lib Allow for overriding only specific Mustache templates/partials. (# 1719) Sep 7, 2021 licenses Add clipboard button to upload modal. Fixes #1401. Sep 2, 2019 test Allow for overriding only specific Mustache templates/partials. (# 1719) Sep 7, 2021 .gitattributes Update .gitattributes Sep 24, 2018 .gitignore fixes #1723: Github Actions Supported (#1729) Jun 14, 2021 CONTRIBUTING.md Faster tests (#1686) Feb 26, 2021 Dockerfile Docker support within the repository (#1732) Aug 3, 2021 Gemfile Faster tests (#1686) Feb 26, 2021 HISTORY.md Release 5.2.3 Apr 18, 2021 LICENSE Package assets (#1493) Mar 24, 2020 README.md Allow for overriding only specific Mustache templates/partials. (# 1719) Sep 7, 2021 Rakefile Set environment to production when precompiling (#1554) Apr 14, 2020 config.rb Restoring config files to repo root Aug 12, 2015 config.ru Restoring config files to repo root Aug 12, 2015 docker-run.sh Docker support within the repository (#1732) Aug 3, 2021 gollum.gemspec Update gollum.gemspec (#1749) Aug 28, 2021 View code [ ] gollum -- A git-based Wiki DESCRIPTION SYSTEM REQUIREMENTS INSTALLATION Markups Markdown flavors RUNNING FROM SOURCE Rack Rack, with an authentication server Docker Service CONFIGURATION Config file CONTRIBUTING THANKS TO README.md gollum -- A git-based Wiki Gem Version Build Status Open Source Helpers Cutting Edge Dependency Status Gollum version 5.0 is out! See here for a list of changes and new features compared to Gollum version 4.x, and see some Screenshots of Gollum's features. DESCRIPTION Gollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository of a specific nature: * A Gollum repository's contents are human-editable text or markup files. * Pages may be organized into directories any way you choose. * Other content can also be included, for example images, PDFs and headers/footers for your pages. * Gollum pages: + May be written in a variety of markups. + Can be edited with your favourite system editor or IDE (changes will be visible after committing) or with the built-in web interface. + Can be displayed in all versions, reverted, etc. * Gollum strives to be compatible with GitHub wikis (see --lenient-tag-lookup) * Gollum supports advanced functionality like: + UML diagrams + BibTeX and Citation support + Annotations using CriticMarkup + Mathematics via MathJax + Macros + Redirects + RSS Feed of latest changes + ...and more SYSTEM REQUIREMENTS Gollum runs on Unix-like systems using its adapter for rugged by default. You can also run Gollum on JRuby via its adapter for RJGit. On Windows, Gollum runs only on JRuby. INSTALLATION 1. Ruby is best installed either via RVM or a package manager of choice. 2. Gollum is best installed via RubyGems: [sudo] gem install gollum Installation examples for individual systems can be seen here. To run, simply: 1. Run: gollum /path/to/wiki where /path/to/wiki is an initialized Git repository. 2. Open http://localhost:4567 in your browser. See below for information on running Gollum from source, as a Rack app, and more. Markups Gollum allows using different markup languages on different wiki pages. It presently ships with support for the following markups: * Markdown (see below for more information on Markdown flavors) * RDoc You can easily activate support for other markups by installing additional renderers (any that are supported by github-markup): * AsciiDoc -- [sudo] gem install asciidoctor * Creole -- [sudo] gem install creole * MediaWiki -- [sudo] gem install wikicloth * Org -- [sudo] gem install org-ruby * Pod -- requires Perl >= 5.10 (the perl command must be available on your command line) + Lower versions should install Pod::Simple from CPAN. * ReStructuredText -- requires python >= 2 (the python2 command must be available on your command line) + Note that Gollum will also need you to install docutils for your Python 2. * Textile -- [sudo] gem install RedCloth Markdown flavors By default, Gollum ships with the kramdown gem to render Markdown. However, you can use any Markdown renderer supported by github-markup . This includes CommonMark support via the commonmarker gem. The first installed renderer from the list will be used (e.g., redcarpet will NOT be used if github/markdown is installed). Just gem install the renderer of your choice. See here for instructions on how to use custom rendering gems and set custom options. RUNNING FROM SOURCE 1. git clone https://github.com/gollum/gollum 2. cd gollum 3. [sudo] bundle install 4. bundle exec bin/gollum 5. Open http://localhost:4567 in your browser. Rack Gollum can also be ran with any rack-compatible web server. More on that over here. Rack, with an authentication server Gollum can also be ran alongside a CAS (Central Authentication Service) SSO (single sign-on) server. With a bit of tweaking, this adds basic user-support to Gollum. To see an example and an explanation, navigate over here. Docker Gollum can also be ran via Docker. More on that over here. Service Gollum can also be ran as a service. More on that over here. CONFIGURATION Gollum comes with the following command line options: Option Arguments Description --host [HOST] Specify the hostname or IP address to listen on. Default: '0.0.0.0'.^1 --port [PORT] Specify the port to bind Gollum with. Default: 4567. --config [FILE] Specify path to Gollum's configuration file. --ref [REF] Specify the git branch to serve. Default: master. --bare none Tell Gollum that the git repository should be treated as bare. --adapter [ADAPTER] Launch Gollum using a specific git adapter. Default: rugged.^2 Specify the leading portion of all Gollum URLs (path info). Setting this --base-path [PATH] to /wiki will make the wiki accessible under http:// localhost:4567/wiki/. Default: /. Specify the subdirectory for all pages. If set, Gollum will only serve --page-file-dir [PATH] pages from this directory and its subdirectories. Default: repository root. Use static assets. Defaults to false --static, --no-static none in development/test, true in production/staging. --assets [PATH] Set the path to look for static assets. Tell Gollum to inject custom CSS into --css none each page. Uses custom.css from wiki root.^3 Tell Gollum to inject custom JS into --js none each page. Uses custom.js from wiki root.^3 --no-edit none Disable the feature of editing pages. --follow-renames, none Follow pages across renames in the --no-follow-renames History view. Default: true. Enable file uploads. If set to dir, Gollum will store all uploads in the --allow-uploads [MODE] /uploads/ directory in repository root. If set to page, Gollum will store each upload at the currently edited page.^4 Enables MathJax (renders mathematical --mathjax none equations). By default, uses the TeX-AMS-MML_HTMLorMML config with the autoload-all extension.^5 --critic-markup none Enable support for annotations using CriticMarkup. --irb none Launch Gollum in "console mode", with a predefined API. --h1-title none Tell Gollum to use the first

as page title. --no-display-metadata none Do not render metadata tables in pages. Tell Gollum to use specific user --user-icons [MODE] icons for history view. Can be set to gravatar, identicon or none. Default: none. Specify path to a custom MathJax --mathjax-config [FILE] configuration. If not specified, uses the mathjax.config.js file from repository root. Specify custom mustache template --template-dir [PATH] directory. Only overrides templates that exist in this directory. --template-page none Use _Template in root as a template for new pages. Must be committed. Parse and interpret emoji tags (e.g. --emoji none :heart:) except when the leading colon is backslashed (e.g. \:heart:). Internal links resolve case-insensitively, will treat spaces --lenient-tag-lookup none as hyphens, and will match the first page found with a certain filename, anywhere in the repository. Provides compatibility with Gollum 4.x. --help none Display the list of options on the command line. --version none Display the current version of Gollum. --versions none Display the current version of Gollum and auxiliary gems. Notes: 1. The 0.0.0.0 IP address allows remote access. Should you wish for Gollum to turn into a personal Wiki, use 127.0.0.1. 2. Before using --adapter, you should probably read this first. 3. When --css or --js is used, respective files must be committed to your git repository or you will get a 302 redirect to the create a page. 4. Files can be uploaded simply by dragging and dropping them onto the editor's text area when --allow-uploads is used. Config file When --config option is used, certain inner parts of Gollum can be customized. This is used throughout our wiki for certain user-level alterations, among which customizing supported markups will probably stand out. All of the mentioned alterations work both for Gollum's config file (config.rb) and Rack's config file (config.ru). CONTRIBUTING Please consider helping out! See CONTRIBUTING for information on how to submit issues, and how to start hacking on gollum. THANKS TO Testing Powered By SauceLabs About A simple, Git-powered wiki with a sweet API and local frontend. Topics wiki documentation-tool gollum jruby-support Resources Readme License MIT License Releases 88 tags Packages 0 No packages published Used by 452 * @Snuggle * @josephjohncox * @kevinlowrie * @nittaya1990 * @Lionz01 * @VergeDX * @ttak0422 + 444 Contributors 174 * @bootstraponline * @dometto * @technoweenie * @mojombo * @bartkamphorst * @atmos * @kristi * @josh * @dekimsey * @benjaminwil * @vmg + 163 contributors Languages * Ruby 45.0% * JavaScript 38.3% * Shell 5.5% * Mustache 4.6% * SCSS 4.1% * HTML 1.8% * Other 0.7% * (c) 2021 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.