[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-7631":3},{"id":4,"name":5,"fullName":6,"owner":5,"repo":5,"description":7,"homepage":8,"htmlUrl":9,"language":10,"languages":9,"totalLinesOfCode":9,"stars":11,"forks":12,"watchers":13,"openIssues":14,"contributorsCount":15,"subscribersCount":15,"size":15,"stars1d":16,"stars7d":17,"stars30d":18,"stars90d":15,"forks30d":15,"starsTrendScore":17,"compositeScore":19,"rankGlobal":9,"rankLanguage":9,"license":20,"archived":21,"fork":21,"defaultBranch":22,"hasWiki":23,"hasPages":21,"topics":24,"createdAt":9,"pushedAt":9,"updatedAt":31,"readmeContent":32,"aiSummary":33,"trendingCount":15,"starSnapshotCount":15,"syncStatus":34,"lastSyncTime":35,"discoverSource":36},7631,"gollum","gollum\u002Fgollum","A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.","",null,"Ruby",14277,1558,241,73,0,1,3,16,44.58,"MIT License",false,"master",true,[25,26,5,27,28,29,30],"documentation","documentation-tool","jruby-support","markdown","ruby","wiki","2026-06-12 02:01:42","# gollum - A git-based Wiki\n\n[![Gem Version](https:\u002F\u002Fbadge.fury.io\u002Frb\u002Fgollum.svg)](http:\u002F\u002Fbadge.fury.io\u002Frb\u002Fgollum)\n[![Build Status](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Factions\u002Fworkflows\u002Ftest.yaml\u002Fbadge.svg)](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Factions\u002Fworkflows\u002Ftest.yaml)\n[![Open Source Helpers](https:\u002F\u002Fwww.codetriage.com\u002Fgollum\u002Fgollum\u002Fbadges\u002Fusers.svg)](https:\u002F\u002Fwww.codetriage.com\u002Fgollum\u002Fgollum)\n[![Cutting Edge Dependency Status](https:\u002F\u002Fcuttingedge.onrender.com\u002Fgithub\u002Fgollum\u002Fgollum\u002Fsvg 'Cutting Edge Dependency Status')](https:\u002F\u002Fcuttingedge.onrender.com\u002Fgithub\u002Fgollum\u002Fgollum\u002Finfo)\n[![Docker Pulls](https:\u002F\u002Fimg.shields.io\u002Fdocker\u002Fpulls\u002Fgollumwiki\u002Fgollum)](https:\u002F\u002Fhub.docker.com\u002Fr\u002Fgollumwiki\u002Fgollum)\n[![License](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002Fgollum\u002Fgollum)](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fblob\u002Fmaster\u002FLICENSE)\n[![GitHub Contributors](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fcontributors\u002Fgollum\u002Fgollum)](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fgraphs\u002Fcontributors)\n\nGollum is a simple wiki system built on top of Git. A Gollum Wiki is simply a git repository of a specific nature:\n\n*   A Gollum repository's contents are human-editable text or markup files.\n*   Pages may be organized into directories any way you choose.\n*   Other content can also be included, for example images, PDFs and headers\u002Ffooters for your pages.\n*   Gollum pages:\n    *   May be written in a variety of [markups](#markups).\n    *   Can be edited with your favourite editor (changes will be visible after committing) or with the built-in web interface.\n    *   Can be displayed in all versions, reverted, etc.\n*   Gollum strives to be [compatible](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002F5.0-release-notes#compatibility-option) with [GitHub](https:\u002F\u002Fdocs.github.com\u002Fen\u002Fcommunities\u002Fdocumenting-your-project-with-wikis\u002Fabout-wikis) and [GitLab](https:\u002F\u002Fdocs.gitlab.com\u002Fee\u002Fuser\u002Fproject\u002Fwiki\u002F#create-or-edit-wiki-pages-locally) wikis.\n    *   Just clone your GitHub\u002FGitLab wiki and view and edit it locally!\n*   Gollum supports advanced functionality like:\n    *   Diagrams using [Mermaid](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki#mermaid-diagrams) or [PlantUML](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki#plantuml-diagrams)\n    *   [BibTeX and Citation support](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FBibTeX-and-Citations)\n    *   Annotations using [CriticMarkup](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki#criticmarkup-annotations)\n    *   [Mathematics](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki#mathematics) via KaTeX or MathJax\n    *   [Macros](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FStandard-Macros)\n    *   [Redirects](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki#redirects)\n    *   [RSS Feed](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002F5.0-release-notes#rss-feed) of latest changes\n    *   ...and [more](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki)\n\nSee the [wiki](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki) for extensive documentation, along with [screenshots](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FScreenshots) of Gollum's features.\n\n---\n\n## Table of Contents\n\n- [System Requirements](#system-requirements)\n- [Installation](#installation)\n  - [As a Ruby Gem](#as-a-ruby-gem)\n  - [Via Docker](#via-docker)\n  - [As a Web Application Resource (Java)](#as-a-web-application-resource-java)\n- [Markups](#markups)\n  - [Markdown Flavors](#markdown-flavors)\n- [Running Gollum](#running-gollum)\n  - [Quick Start from Command Line](#quick-start-from-command-line)\n  - [Running From Source](#running-from-source)\n  - [Running with Rack](#running-with-rack)\n  - [Running with an Authentication Server](#running-with-an-authentication-server)\n  - [Running as a Service](#running-as-a-service)\n- [Environment](#environment)\n- [Configuration](#configuration)\n  - [Command-Line Options](#command-line-options)\n  - [Config File](#config-file)\n- [Contributing](#contributing)\n\n---\n\n## System Requirements\n\nGollum runs both on Unix-like systems and on Windows.\n\nGollum runs either using 'normal' Ruby (MRI) or [JRuby](https:\u002F\u002Fgithub.com\u002Fjruby\u002Fjruby) (Ruby on the Java Virtual Machine). On Windows, Gollum runs only using JRuby (either from source, or [prebuilt](#as-a-web-application-resource-java)).\n\nOn MRI, Gollum uses the [rugged](https:\u002F\u002Fgithub.com\u002Flibgit2\u002Frugged) git library, while on JRuby\u002FJava it utilizes the [rjgit](https:\u002F\u002Fgithub.com\u002Frepotag\u002Frjgit) and [JGit](https:\u002F\u002Feclipse.dev\u002Fjgit\u002F) libraries. See [here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGit-adapters) for more info.\n\n## Installation\n\n### As a Ruby Gem\n\nRuby is best installed either via [RVM](https:\u002F\u002Frvm.io\u002F) or a package manager of choice. Then simply:\n\n```bash\ngem install gollum\n```\n\nInstallation examples for individual systems can be seen [here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FInstallation).\n\n### Via Docker\n\nSee [here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGollum-via-Docker) for instructions on how to run Gollum via Docker.\n\n### As a Web Application Resource (Java)\n\nThe [latest Release](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Freleases\u002F) of Gollum will always contain a downloadable `gollum.war` file that can be directly executed on any system with a working Java installation:\n\n```bash\njava -jar gollum.war -S gollum \u003Cyour-gollum-arguments-here>\n```\n\nWhen using the `.war`, please be sure to pass [absolute paths](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGollum-via-Java-WAR#absolute-paths-issue) to your Gollum arguments.\n\n## Markups\n\nGollum allows using different markup languages on different wiki pages. It presently ships with support for the following markups:\n\n*   [Markdown](http:\u002F\u002Fdaringfireball.net\u002Fprojects\u002Fmarkdown\u002Fsyntax) (see [below](#markdown-flavors) for more information on Markdown flavors)\n*   [RDoc](http:\u002F\u002Frdoc.sourceforge.net\u002F)\n\nYou can easily activate support for other markups by installing additional renderers (any that are supported by [github-markup](https:\u002F\u002Fgithub.com\u002Fgithub\u002Fmarkup)):\n\n*   [AsciiDoc](http:\u002F\u002Fasciidoctor.org\u002Fdocs\u002Fasciidoc-syntax-quick-reference\u002F) -- `gem install asciidoctor`\n*   [Creole](http:\u002F\u002Fwww.wikicreole.org\u002Fwiki\u002FCheatSheet) -- `gem install creole`\n*   [MediaWiki](http:\u002F\u002Fwww.mediawiki.org\u002Fwiki\u002FHelp:Formatting) -- `gem install wikicloth`\n*   [Org](http:\u002F\u002Forgmode.org\u002Fworg\u002Fdev\u002Forg-syntax.html) -- `gem install org-ruby`\n*   [Pod](http:\u002F\u002Fperldoc.perl.org\u002Fperlpod.html) -- requires Perl >= 5.10 (the `perl` command must be available on your command line)\n    *   Lower versions should install `Pod::Simple` from CPAN.\n*   [ReStructuredText](http:\u002F\u002Fdocutils.sourceforge.net\u002Fdocs\u002Fref\u002Frst\u002Frestructuredtext.html) -- requires python >= 3\n    *   Note that Gollum will also need you to install `docutils` for python\n*   [Textile](http:\u002F\u002Fredcloth.org\u002Fhobix.com\u002Ftextile\u002Fquick.html) -- `gem install RedCloth`\n\n### Markdown Flavors\n\nBy default, Gollum ships with the `kramdown` gem to render Markdown. However, you can use any [Markdown renderer supported by github-markup](https:\u002F\u002Fgithub.com\u002Fgithub\u002Fmarkup\u002Fblob\u002Fmaster\u002Flib\u002Fgithub\u002Fmarkup\u002Fmarkdown.rb). This includes [CommonMark](https:\u002F\u002Fcommonmark.org\u002F) support via the `commonmarker` gem. The first installed renderer from the list will be used (e.g., `redcarpet` will NOT be used if `github\u002Fmarkdown` is installed). Just `gem install` the renderer of your choice.\n\nSee [here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FCustom-rendering-gems) for instructions on how to use custom rendering gems and set custom options.\n\n## Running Gollum\n\n### Quick Start from Command Line\n\n1.  Run: `gollum \u002Fpath\u002Fto\u002Fwiki` where `\u002Fpath\u002Fto\u002Fwiki` is an initialized Git repository.\n2.  Open `http:\u002F\u002Flocalhost:4567` in your browser.\n\n### Running From Source\n\n1.  `git clone https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum`\n2.  `cd gollum`\n3.  `bundle install` (may require `sudo` depending on your Ruby setup)\n4.  `bundle exec bin\u002Fgollum`\n5.  Open `http:\u002F\u002Flocalhost:4567` in your browser.\n\n### Running with Rack\n\nGollum can also be run with any [rack-compatible web server](https:\u002F\u002Fgithub.com\u002Frack\u002Frack#supported-web-servers). More on that [over here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGollum-via-Rack).\n\n### Running with an Authentication Server\n\nGollum can also be run 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](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGollum-via-Rack-and-CAS-SSO).\n\n### Running as a Service\n\nGollum can also be run as a service. More on that [over here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGollum-as-a-service).\n\n## Environment\n\nGollum uses the environment variable `APP_ENV` primarily to control how the underlying Sinatra app behaves:\n\n*   `development` – reload the app on every request\n*   `production` – load the app only once\n\n## Configuration\n\nGollum comes with the command line options listed below. Note that there are some additional 'minor' options to tweak Gollum's behaviour that do not have commandline options, but can be configured in [config.rb](#config-file).\n\n### Command-Line Options\n\n| Option                  | Arguments           | Description                                                                                                                                                               |\n| ----------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `--host`                | `[HOST]`            | Specify the hostname or IP address to listen on. Default: '0.0.0.0'. (Note: `0.0.0.0` allows remote access. For a personal Wiki, use `127.0.0.1`.)                   |\n| `--port`                | `[PORT]`            | Specify the port to bind Gollum with. Default: `4567`.                                                                                                                      |\n| `--config`              | `[FILE]`            | Specify path to Gollum's [configuration file](#config-file).                                                                                                             |\n| `--ref`                 | `[REF]`             | Specify the git branch to serve. Default: `main` (or `master` if `main` is not found).                                                                                                    |\n| `--bare`                |                     | Tell Gollum that the git repository should be treated as bare.                                                                                                          |\n| `--adapter`             | `[ADAPTER]`         | Launch Gollum using a specific git adapter. Default: `rugged`. (See [Git Adapters](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FGit-adapters) for more info.)                 |\n| `--base-path`           | `[PATH]`            | Specify the leading portion of all Gollum URLs (path info). Setting this to `\u002Fwiki` will make the wiki accessible under `http:\u002F\u002Flocalhost:4567\u002Fwiki\u002F`. Default: `\u002F`.     |\n| `--page-file-dir`       | `[PATH]`            | Specify the subdirectory for all pages. If set, Gollum will only serve pages from this directory and its subdirectories. Default: repository root.                        |\n| `--static`, `--no-static` |                   | Use static assets. Defaults to `false` in development\u002Ftest, `true` in production\u002Fstaging.                                                                                    |\n| `--assets`              | `[PATH]`            | Set the path to look for static assets.                                                                                                                                   |\n| `--css`                 |                     | Tell Gollum to inject custom CSS into each page. Uses `custom.css` from wiki root (must be committed).                                                                    |\n| `--js`                  |                     | Tell Gollum to inject custom JS into each page. Uses `custom.js` from wiki root (must be committed).                                                                     |\n| `--no-edit`             |                     | Disable the feature of editing pages.                                                                                                                                     |\n| `--allow-uploads`       | `[MODE]`            | Enable file uploads. If set to `dir`, Gollum will store all uploads in the `\u002Fuploads\u002F` directory in repository root. If set to `page`, Gollum will store each upload at the currently edited page. (Files can be uploaded by dragging and dropping onto the editor's text area.) |\n| `--math`                | `[RENDERER]`        | Enable rendering of mathematical equations. Valid renderers: `mathjax`, `katex`. Default: `katex`. Add custom configuration for the renderer to `math.config.js` and commit it to the repo. |\n| `--critic-markup`       |                     | Enable support for annotations using [CriticMarkup](http:\u002F\u002Fcriticmarkup.com\u002F).                                                                                           |\n| `--irb`                 |                     | Launch Gollum in \"console mode\", with a [predefined API](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum-lib\u002F).                                                                          |\n| `--h1-title`            |                     | Tell Gollum to use the first `\u003Ch1>` as page title.                                                                                                                      |\n| `--no-display-metadata` |                     | Do not render metadata tables in pages.                                                                                                                                   |\n| `--user-icons`          | `[MODE]`            | Tell Gollum to use specific user icons for history view. Can be set to `gravatar`, `identicon` or `none`. Default: `none`.                                                  |\n| `--template-dir`        | `[PATH]`            | Specify custom mustache template directory. Only overrides templates that exist in this directory.                                                                      |\n| `--template-page`       |                     | Use `_Template` in root as a template for new pages. Must be committed.                                                                                                   |\n| `--emoji`               |                     | Parse and interpret emoji tags (e.g. `:heart:`) except when the leading colon is backslashed (e.g. `\\:heart:`).                                                           |\n| `--lenient-tag-lookup`  |                     | Internal links resolve case-insensitively, will treat spaces as hyphens, and will match the first page found with a certain filename, anywhere in the repository. Provides compatibility with Gollum 4.x. |\n| `--help`                |                     | Display the list of options on the command line.                                                                                                                          |\n| `--version`             |                     | Display the current version of Gollum.                                                                                                                                    |\n| `--versions`            |                     | Display the current version of Gollum and auxiliary gems.                                                                                                                 |\n\n### Config File\n\nWhen the `--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](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FFormats-and-extensions) will probably stand out.\n\nSee [here](https:\u002F\u002Fgithub.com\u002Fgollum\u002Fgollum\u002Fwiki\u002FSample-config.rb) for documentation about settings configurable in `config.rb`.\n\nAll of the mentioned alterations and options work both for Gollum's config file (`config.rb`) and Rack's config file (`config.ru`).\n\n## Contributing\n\nPlease consider helping out! See [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to submit issues, and how to start hacking on gollum.\n","Gollum 是一个基于 Git 的简单维基系统。其核心功能包括支持多种标记语言（如 Markdown）、允许用户通过本地编辑器或内置网页界面编辑内容，并能够显示页面的所有版本及回滚。此外，Gollum 还提供了高级特性，例如使用 Mermaid 或 PlantUML 绘制图表、BibTeX 引用支持、数学公式渲染等。此项目非常适合需要快速搭建文档站点的团队或个人，尤其是在已经采用 Git 作为版本控制工具的情况下，可以轻松地与 GitHub 或 GitLab 的 Wiki 功能集成，实现本地克隆、查看和编辑远程 Wiki 内容的能力。",2,"2026-06-11 03:13:26","top_language"]