gollum 4.1.4 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 634cc4fc018daf2a0136c3efb1e9ab04960a1ff910007a7d958a7b225ffdd79b
-  data.tar.gz: 94a7266abd64ad6610b8844a61e2da2cfb896cfa5ed00013377c3a44709aea46
+  metadata.gz: 3746893fd4bb885fa53c453b7224916685babb8c129a65d56ccd8c31b73e0d43
+  data.tar.gz: 1a83709ed4921c25ea91743b36b27dc788409866a4705b71eb285920696b9853
 SHA512:
-  metadata.gz: 06f3c7b6ee5a0e241d903177533ceaf67bcd7557d45ba8795c4246294ff1cd8cb218641dc3ed1477b608ca22953a421bfe96249b1f4c3e510ca27dd94b332482
-  data.tar.gz: d30674aba9777221765f94319dde7424c9842abfec89a15867fe2f61e52dc9d259e9b6bd0ef35c2d3ff580e233e4ddf2cbf5e2bee6e4a000af106baf51ae01f5
+  metadata.gz: f43522071d711ee1fa8446636fc621db6be4c3721184018a8a050f11fb6485ef06642f0b09f056a9ec4cf3ac5da58f6b75f06315cc78823d0ce8ed35990e9c82
+  data.tar.gz: 447f15b9174f3375825739f35f54baea66e5f583337aeb1e7ccbb87d439cd04cd1f21216e074c6dae01514261c6f6a1937558b8969621237cc543418f19f4536

data/CONTRIBUTING.md

@@ -78,6 +78,15 @@ git commit -am "Add test"
 git push ../lotr.git/ master
 ```
 
+## Updating static assets
+
+This is necessary whenever changes have been made to the assets in `lib/gollum/public/gollum/javascript` (mostly SASS, CSS, and JS files), to ensure the changes are also present in the [released](#releasing-the-gem) version of the gem. Steps:
+
+1. `git rm -r lib/gollum/public/assets`
+1. `bundle exec rake precompile`
+1. `git add lib/gollum/public/assets`
+1. `git commit`
+
 ## Releasing the gem
 
 Gollum uses [Semantic Versioning](http://semver.org/).

data/Gemfile

@@ -1,4 +1,10 @@
 source 'https://rubygems.org'
 
+if RUBY_PLATFORM == 'java'
+  gem 'warbler'
+end
+
 gemspec
-gem 'rake', '~> 10.4'
+
+gem "rake", '~> 12.3', '>= 12.3.3'
+

data/HISTORY.md

@@ -1,3 +1,13 @@
+# 5.0 / 2020-03-17
+
+This is a major new release that introduces many new features, bugfixes, and removes major limitations. See [here](https://github.com/gollum/gollum/wiki/5.0-release-notes) for a list of changes.
+
+**Note**: due to changes to the way in which Gollum handles filenames, you may have to change some links in your wiki when migrating from gollum 4.x. See the [release notes](https://github.com/gollum/gollum/wiki/5.0-release-notes#migrating-your-wiki) for more details. You may be find the `bin/gollum-migrate-tags` script helpful to accomplish this. Also see the `--lenient-tag-lookup` option for making tag lookup backwards compatible with 4.x, though note that this will decrease performance on large wikis with many tags.
+
+Many thanks to all the users who have provided feedback, and everyone who has chipped in in the development process!
+
+Many of these changes have been made possible by removing the default grit adapter in favour of the new [rugged adapter](https://github.com/gollum/rugged_adapter).
+
 # 4.1.4 /2018-01-10
 
 * Depend on new version of gollum-lib that relies on a patched version of sanitize, which solves a vulnerability (CVE-2018-3740). See https://github.com/gollum/gollum-lib/pull/296.

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) Tom Preston-Werner, Rick Olson
+Copyright (c) Tom Preston-Werner, Rick Olson, Dawa Ometto, Bart Kamphorst
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.md

@@ -5,84 +5,57 @@ gollum -- A git-based Wiki
 [![Build Status](https://travis-ci.org/gollum/gollum.svg?branch=master)](https://travis-ci.org/gollum/gollum)
 [![Open Source Helpers](https://www.codetriage.com/gollum/gollum/badges/users.svg)](https://www.codetriage.com/gollum/gollum)
 
+**Gollum version 5.0 is out!** See [here](https://github.com/gollum/gollum/wiki/5.0-release-notes) for a list of changes and new features compared to Gollum version 4.x, and see some [Screenshots](https://github.com/gollum/gollum/wiki/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 (either bare or regular) of a specific nature:
-* A Gollum repository's contents are human-editable, unless the repository is bare. Pages are unique text files which 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 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](#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 (commits).
-
-Gollum can be launched either as a webserver (with the web interface) or in "console mode", where you can use a predefined API to query and manipulate the repository. For more information, see the [Running](#running) and [Configuration](#configuration) sections.
-
-For more information on Gollum's capabilities and pitfalls:
-
-1. [Syntax/capability overview for pages](https://github.com/gollum/gollum/wiki).
-2. [Known limitations](https://github.com/gollum/gollum/wiki/Known-limitations).
-3. [Troubleshoot guide](https://github.com/gollum/gollum/wiki/Troubleshoot-guide).
-4. [Security overview](https://github.com/gollum/gollum/wiki/Security).
-
-### Videos
-
-* [Quick impression of gollum](https://www.youtube.com/watch?v=gj1qqK3Oku8)
-* [Gollum overview and simple markdown tutorial (german with english subtitles)](https://www.youtube.com/watch?v=wfWgDRmcbU4)
-* [Advanced features in action](https://www.youtube.com/watch?v=EauxgxsLDC4)
-
-## SYSTEM REQUIREMENTS
-
-| Operating System | Ruby           | Adapters           | Supported |
-| ---------------- | -------------- | ------------------ | --------- |
-| Unix/Linux-like  | Ruby (MRI) 2.1.0+   | all except [RJGit](https://github.com/repotag/rjgit) | yes |
-| Unix/Linux-like  | [JRuby](https://github.com/jruby/jruby) (1.9.3+ compatible) | [RJGit](https://github.com/repotag/rjgit) | yes |
-| Windows          | Ruby (MRI) 2.1.0+  | all except [RJGit](https://github.com/repotag/rjgit) | no  |
-| Windows          | [JRuby](https://github.com/jruby/jruby) (1.9.3+ compatible) | [RJGit](https://github.com/repotag/rjgit) | almost<sup>1</sup> |
-
-**Notes:**
-
-1. There are still some bugs and this setup is not ready for production yet. You can track the progress at [Support Windows via JRuby - Meta Issue](https://github.com/gollum/gollum/issues/1044).
+	* Can be displayed in all versions, reverted, etc.
+* Gollum strives to be compatible with GitHub wikis (see `--hyphened-tag-lookup`)
+* Gollum supports advanced functionality like:
+  * [UML diagrams](https://github.com/gollum/gollum/wiki#plantuml-diagrams)
+  * [BibTeX and Citation support](https://github.com/gollum/gollum/wiki/BibTeX-and-Citations)
+  * Annotations using [CriticMarkup](https://github.com/gollum/gollum/wiki#criticmarkup-annotations)
+  * Mathematics via [MathJax](https://github.com/gollum/gollum/wiki#mathematics)
+  * [Macros](https://github.com/gollum/gollum/wiki/Standard-Macros)
+  * [Redirects](https://github.com/gollum/gollum/wiki#redirects)
+  * [RSS Feed](https://github.com/gollum/gollum/wiki/5.0-release-notes#rss-feed) of latest changes
+  * ...and [more](https://github.com/gollum/gollum/wiki)
+
+### SYSTEM REQUIREMENTS
+
+Gollum runs on Unix-like systems using its [adapter](https://github.com/gollum/rugged_adapter) for [rugged](https://github.com/libgit2/rugged) by default. You can also run Gollum on [JRuby](https://github.com/jruby/jruby) via its [adapter](https://github.com/repotag/gollum-lib_rjgit_adapter) for [RJGit](https://github.com/repotag/rjgit/). On Windows, Gollum runs only on JRuby.
 
 ## INSTALLATION
 
-Varies depending on operating system, package manager and Ruby installation. Generally, you should first install Ruby and then Gollum.
-
 1. Ruby is best installed either via [RVM](https://rvm.io/) 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](https://github.com/gollum/gollum/wiki/Installation).
 
-**Notes:**  
-* Whichever Ruby implementation you're using, Gollum ships with the appropriate default git adapter. So the above installation procedure is common for both MRI and JRuby.
-* If you're installing from source:
-	* Optionally uninstall any previous versions of Gollum:  
-		```
-		[sudo] gem uninstall -aIx gollum
-		```
-	* Install [Bundler](http://bundler.io/).
-	* Navigate to the cloned source of Gollum.
-	* Install dependencies:  
-		```
-		[sudo] bundle install
-		```
-	* Build:  
-		```
-		rake build
-		```
-	* And install:  
-		```
-		[sudo] gem install --no-document pkg/gollum*.gem
-		```
+To run, simply:
+
+1. Run: `gollum /path/to/wiki`.
+2. Open `http://localhost:4567` in your browser.
+
+See [below](#running-from-source) for information on running Gollum from source, as a Rack app, and more.
 
 ### Markups
 
-Gollum presently ships with support for the following markups:
-* [Markdown](http://daringfireball.net/projects/markdown/syntax)
+Gollum allows using different markup languages on different wiki pages. It presently ships with support for the following markups:
+* [Markdown](http://daringfireball.net/projects/markdown/syntax) (see [below](#Markdown-flavors) for more information on Markdown flavors)
 * [RDoc](http://rdoc.sourceforge.net/)
 
-Since all markups are rendered by the [github-markup](https://github.com/github/markup) gem, you can easily add support for other markups by additional installation:
+You can easily activate support for other markups by installing additional renderers (any that are supported by [github-markup](https://github.com/github/markup)):
 * [AsciiDoc](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/) -- `[sudo] gem install asciidoctor`
 * [Creole](http://www.wikicreole.org/wiki/CheatSheet) -- `[sudo] gem install creole`
 * [MediaWiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `[sudo] gem install wikicloth`
@@ -90,28 +63,21 @@ Since all markups are rendered by the [github-markup](https://github.com/github/
 * [Pod](http://perldoc.perl.org/perlpod.html) -- requires Perl >= 5.10 (the `perl` command must be available on your command line)
 	* Lower versions should install `Pod::Simple` from CPAN.
 * [ReStructuredText](http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html) -- 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. Installation procedure can, again, vary depending on operating system and package manager.
+	* Note that Gollum will also need you to install `docutils` for your Python 2.
 * [Textile](http://redcloth.org/hobix.com/textile/quick.html) -- `[sudo] gem install RedCloth`
 
-By default, Gollum ships with the `kramdown` gem to render Markdown. However, you can use any [Markdown renderer supported by github-markup](https://github.com/github/markup/blob/master/lib/github/markup/markdown.rb). The thing to remember is that the first installed renderer from the list will be used. So, for example, `redcarpet` will NOT be used if `github/markdown` is installed.
+### Markdown flavors
 
-## RUNNING
+By default, Gollum ships with the `kramdown` gem to render Markdown. However, you can use any [Markdown renderer supported by github-markup](https://github.com/github/markup/blob/master/lib/github/markup/markdown.rb). This includes [CommonMark](https://commonmark.org/) 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.
 
-Simply:
+See [here](https://github.com/gollum/gollum/wiki/Custom-rendering-gems) for instructions on how to use custom rendering gems and set custom options.
 
-1. Navigate to your git repository (wiki) via the command line.
-2. Run: `gollum`.
-3. Open `http://localhost:4567` in your browser.
-
-This will start up a web server (WEBrick) running Gollum with a web interface, where you can view and edit your wiki.
-
-### Running from source
+## RUNNING FROM SOURCE
 
 1. `git clone https://github.com/gollum/gollum`
 2. `cd gollum`
-3. `[sudo] bundle install` (may not always be necessary).
+3. `[sudo] bundle install`
 4. `bundle exec bin/gollum`
-	* Like that, gollum assumes the target wiki (git repository) is the project repository itself. If it's not, execute `bundle exec bin/gollum <path-to-wiki>` instead.
 5. Open `http://localhost:4567` in your browser.
 
 ### Rack
@@ -136,42 +102,49 @@ 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`.<sup>1</sup> |
+| --host            | [HOST]    | Specify the hostname or IP address to listen on. Default: '0.0.0.0'.<sup>1</sup> |
 | --port            | [PORT]    | Specify the port to bind Gollum with. Default: `4567`. |
-| --config          | [FILE]  | Specify path to Gollum's configuration file. |
+| --config          | [FILE]    | Specify path to Gollum's configuration file. |
 | --ref             | [REF]     | Specify the git branch to serve. Default: `master`. |
-| --adapter         | [ADAPTER] | Launch Gollum using a specific git adapter. Default: `grit`.<sup>2</sup> |
-| --bare            | none      | Tell Gollum that the git repository should be treated as bare. This is only necessary when using the default grit adapter. |
+| --bare            | none      | Tell Gollum that the git repository should be treated as bare. |
+| --adapter         | [ADAPTER] | Launch Gollum using a specific git adapter. Default: `rugged`.<sup>2</sup> |
 | --base-path       | [PATH]    | Specify the leading portion of all Gollum URLs (path info). Setting this to `/wiki` will make the wiki accessible under `http://localhost:4567/wiki/`. Default: `/`. |
 | --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. |
-| --css             | none      | Tell Gollum to inject custom CSS into each page. Uses `custom.css` from repository root.<sup>3,5</sup> |
-| --js              | none      | Tell Gollum to inject custom JS into each page. Uses `custom.js` from repository root.<sup>3,5</sup> |
-| --emoji           | none      | Parse and interpret emoji tags (e.g. :heart:). |
+| --static, --no-static | none  | Use static assets. Defaults to false in development/test,  true in production/staging. |
+| --assets          |  [PATH]   | Set the path to look for static assets. |
+| --css             | none      | Tell Gollum to inject custom CSS into each page. Uses `custom.css` from wiki root.<sup>3</sup> |
+| --js              | none      | Tell Gollum to inject custom JS into each page. Uses `custom.js` from wiki root.<sup>3</sup> |
 | --no-edit         | none      | Disable the feature of editing pages. |
-| --live-preview    | none      | Enable the live preview feature in page editor. |
-| --no-live-preview | none      | Disable the live preview feature in page editor. |
+| --follow-renames, --no-follow-renames  | none      | Follow pages across renames in the History view. Default: true.
 | --allow-uploads   | [MODE]    | Enable file uploads. If set to `dir`, Gollum will store all uploads in the `/uploads/` directory in repository root. If set to `page`, Gollum will store each upload at the currently edited page.<sup>4</sup> |
 | --mathjax         | none      | Enables MathJax (renders mathematical equations). By default, uses the `TeX-AMS-MML_HTMLorMML` config with the `autoload-all` extension.<sup>5</sup> |
+| --critic-markup   | none      | Enable support for annotations using [CriticMarkup](http://criticmarkup.com/). |
 | --irb             | none      | Launch Gollum in "console mode", with a [predefined API](https://github.com/gollum/gollum-lib/). |
 | --h1-title        | none      | Tell Gollum to use the first `<h1>` as page title. |
-| --show-all        | none      | Tell Gollum to also show files in the file view. By default, only valid pages are shown. |
-| --collapse-tree   | none      | Tell Gollum to collapse the file tree, when the file view is opened. By default, the tree is expanded. |
+| --no-display-metadata | none  | Do not render metadata tables in pages. |
 | --user-icons      | [MODE]    | Tell Gollum to use specific user icons for history view. Can be set to `gravatar`, `identicon` or `none`. Default: `none`. |
 | --mathjax-config  | [FILE]    | Specify path to a custom MathJax configuration. If not specified, uses the `mathjax.config.js` file from repository root. |
 | --template-dir    | [PATH]    | Specify custom mustache template directory. |
+| --template-page   | none      | Use _Template in root as a template for new pages. Must be committed. |
+| --emoji           | none      | Parse and interpret emoji tags (e.g. `:heart:`) except when the leading colon is backslashed (e.g. `\:heart:`). |
+| --lenient-tag-lookup | none | 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. |
 | --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](https://github.com/gollum/gollum/wiki/Git-adapters) 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 (this is, however exclusive to the default editor, not the live preview editor).
-5. Read the relevant [Security note](https://github.com/gollum/gollum/wiki/Security#custom-cssjs--mathjax-config) before using these.
+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](https://github.com/gollum/gollum/wiki/Formats-and-extensions) 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](CONTRIBUTING.md) for information on how to submit issues, and how to start hacking on gollum.

data/Rakefile

@@ -71,6 +71,7 @@ Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test' << '.'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
+  test.warning = false
 end
 
 desc "Generate RCov test coverage and open in your browser"
@@ -133,7 +134,7 @@ end
 
 desc "Build and install"
 task :install => :build do
-  sh "gem install --local --no-ri --no-rdoc pkg/#{name}-#{version}.gem"
+  sh "gem install --local --no-document pkg/#{name}-#{version}.gem"
 end
 
 desc 'Update gemspec'
@@ -177,3 +178,24 @@ task :validate do
     exit!
   end
 end
+
+desc 'Precompile assets'
+task :precompile do
+  require './lib/gollum/views/helpers.rb'
+  require './lib/gollum/assets.rb'
+  require 'sprockets'
+  require 'sprockets-helpers'
+  require 'sass'
+  env = Precious::Assets.sprockets
+  path = ENV.fetch('GOLLUM_ASSETS_PATH', ::File.join(File.dirname(__FILE__), 'lib/gollum/public/assets'))
+  manifest = Sprockets::Manifest.new(env, path)
+  Sprockets::Helpers.configure do |config|
+    config.environment = env
+    config.prefix      = Precious::Assets::ASSET_URL
+    config.digest      = true
+    config.public_path = path
+    config.manifest    = manifest
+  end
+  puts "Precompiling assets to #{path}..."
+  manifest.compile(Precious::Assets::MANIFEST)
+end

data/bin/gollum

@@ -5,7 +5,8 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'optparse'
 require 'rubygems'
 require 'gollum'
-require 'cgi'
+require 'erb'
+require 'sprockets'
 
 exec         = {}
 options      = {
@@ -13,166 +14,197 @@ options      = {
   :bind => '0.0.0.0',
 }
 wiki_options = {
-  :live_preview  => false,
   :allow_uploads => false,
   :allow_editing => true,
 }
 
 opts = OptionParser.new do |opts|
   # define program name (although this defaults to the name of the file, just in case...)
-  opts.program_name = "gollum"
-    
-  # set basic info for the "--help" command (options will be appended automatically from the below definitions)
+  opts.program_name = 'gollum'
+
+  # set basic info for the '--help' command (options will be appended automatically from the below definitions)
   opts.banner = '
   Gollum is a multi-format Wiki Engine/API/Frontend.
-    
+
   Usage:
       gollum [options] [git-repo]
-    
+
   Arguments:
       [git-repo]                     Path to the git repository being served. If not specified, current working directory is used.
-  
+
   Notes:
       Paths for all options are relative to <git-repo> unless absolute.
       This message is only a basic description. For more information, please visit:
           https://github.com/gollum/gollum
-  
+
   OPTIONS'
-  
-  # define gollum options  
-  opts.separator ""
-  opts.separator "  Major:"
-  
-  opts.on("-h", "--host [HOST]", "Specify the hostname or IP address to listen on. Default: '0.0.0.0'.") do |host|
+
+  # define gollum options
+  opts.separator ''
+  opts.separator '  Major:'
+
+  opts.on('-h', '--host [HOST]', 'Specify the hostname or IP address to listen on. Default: \'0.0.0.0\'.') do |host|
     options[:bind] = host
   end
-  opts.on("-p", "--port [PORT]", "Specify the port to bind Gollum with. Default: '4567'.") do |port|
+  opts.on('-p', '--port [PORT]', 'Specify the port to bind Gollum with. Default: \'4567\'.') do |port|
     begin
-      # don't use "port.to_i" here... it doesn't raise errors which might result in a nice confusion later on
+      # don't use 'port.to_i' here... it doesn't raise errors which might result in a nice confusion later on
       options[:port] = Integer(port)
     rescue ArgumentError
       puts "Error: '#{port}' is not a valid port number."
       exit 1
     end
   end
-  opts.on("-c", "--config [FILE]", "Specify path to the Gollum's configuration file.") do |file|
+  opts.on('-c', '--config [FILE]', 'Specify path to the Gollum\'s configuration file.') do |file|
     options[:config] = file
   end
-  opts.on("-r", "--ref [REF]", "Specify the branch to serve. Default: 'master'.") do |ref|
+  opts.on('-r', '--ref [REF]', 'Specify the branch to serve. Default: \'master\'.') do |ref|
     wiki_options[:ref] = ref
   end
-  opts.on("-a", "--adapter [ADAPTER]", "Launch Gollum using a specific git adapter. Default: 'grit'.") do |adapter|
-    Gollum::GIT_ADAPTER = adapter
-  end
-  opts.on("--bare", "Declare '<git-repo>' to be bare. This is only necessary when using the grit adapter.") do
+  opts.on("--bare", "Declare '<git-repo>' to be bare.") do
     wiki_options[:repo_is_bare] = true
   end
-  opts.on("-b", "--base-path [PATH]", "Specify the leading portion of all Gollum URLs (path info). Default: '/'.",
-    "Example: setting this to '/wiki' will make the wiki accessible under 'http://localhost:4567/wiki/'.") do |base_path|
-      
+  opts.on('-a', '--adapter [ADAPTER]', 'Launch Gollum using a specific git adapter. Default: \'rugged\'.') do |adapter|
+    Gollum::GIT_ADAPTER = adapter
+  end
+  opts.on('-b', '--base-path [PATH]', 'Specify the leading portion of all Gollum URLs (path info). Default: \'/\'.',
+    'Example: setting this to \'/wiki\' will make the wiki accessible under \'http://localhost:4567/wiki/\'.') do |base_path|
+
     # first trim a leading slash, if any
     base_path.sub!(/^\/+/, '')
 
     # make a backup of the option and sanitize it
     base_path_original = base_path.dup
-    base_path = CGI.escape(base_path)
-    
+    base_path = ERB::Util.url_encode(base_path)
+    base_path.gsub!('%2F', '/')
+
     # then let the user know if we changed the URL
     unless base_path_original == base_path
       puts <<MSG
 Warning: your base-path has been sanitized:
-  - original: '#{base_path_original}'
-  - sanitized: '#{base_path}'
+  - original: "#{base_path_original}"
+  - sanitized: "#{base_path}"
 MSG
     end
-      
+
     # and finally, let others enjoy our hard work:
-    wiki_options[:base_path] = base_path
+    wiki_options[:base_path] = base_path unless base_path.empty?
   end
-  opts.on("--page-file-dir [PATH]", "Specify the subdirectory for all pages. Default: repository root.", 
-    "Example: setting this to 'pages' will make Gollum serve only pages at '<git-repo>/pages/*'.") do |path|
+  opts.on('--page-file-dir [PATH]', 'Specify the subdirectory for all pages. Default: repository root.',
+    'Example: setting this to \'pages\' will make Gollum serve only pages at \'<git-repo>/pages/*\'.') do |path|
     wiki_options[:page_file_dir] = path
   end
-  opts.on("--css", "Inject custom CSS into each page. The '<git-repo>/custom.css' file is used (must be committed).") do
+  opts.on('--static', 'Use static assets. Defaults to false in development/test, defaults to true in production/staging.') do
+    wiki_options[:static] = true
+  end
+  opts.on('--no-static', 'Do not use static assets (even when in production/staging).') do
+    wiki_options[:static] = false
+  end
+  opts.on('--assets [PATH]', 'Set the path to look for static assets. Only used if --static is set to true, or environment is production/staging. Default: ./public/assets') do |path|
+    wiki_options[:static_assets_path] = path
+  end
+  opts.on('--css', 'Inject custom CSS into each page. The \'<wiki-root>/custom.css\' file is used (must be committed).') do
     wiki_options[:css] = true
   end
-  opts.on("--js", "Inject custom JavaScript into each page. The '<git-repo>/custom.js' file is used (must be committed).") do
+  opts.on('--js', 'Inject custom JavaScript into each page. The \'<wiki-root>/custom.js\' file is used (must be committed).') do
     wiki_options[:js] = true
   end
-  opts.on("--emoji", "Parse and interpret emoji tags (e.g. :heart:).") do
-    wiki_options[:emoji] = true
-  end
-  opts.on("--no-edit", "Disable the feature of editing pages.")  do
+  opts.on('--no-edit', 'Disable the feature of editing pages.')  do
     wiki_options[:allow_editing] = false
   end
-  opts.on("--live-preview", "Enable the live preview feature in page editor.") do
-    wiki_options[:live_preview] = true
+  opts.on('--follow-renames', 'Follow pages across renames in the History view. Default: true.') do
+    wiki_options[:follow_renames] = true
   end
-  opts.on("--no-live-preview", "Disable the live preview feature in page editor.") do
-    wiki_options[:live_preview] = false
+  opts.on('--no-follow-renames', 'Do not follow pages across renames in the History view.') do
+    wiki_options[:follow_renames] = false
   end
-  opts.on("--allow-uploads [MODE]", [:dir, :page], "Enable file uploads.",
-    "If set to 'dir', Gollum will store all uploads in the '<git-repo>/uploads/' directory.",
-    "If set to 'page', Gollum will store each upload at the currently edited page.") do |mode|
+  opts.on('--allow-uploads [MODE]', [:dir, :page], 'Enable file uploads.',
+    'If set to \'dir\', Gollum will store all uploads in the \'<git-repo>/uploads/\' directory.',
+    'If set to \'page\', Gollum will store uploads per page in \'<git-repo>/uploads/[pagename]\'.') do |mode|
     wiki_options[:allow_uploads]    = true
     wiki_options[:per_page_uploads] = true if mode == :page
   end
-  opts.on("--mathjax", "Enable MathJax (renders mathematical equations).",
-    "By default, uses the 'TeX-AMS-MML_HTMLorMML' config with the 'autoload-all' extension.") do
+  opts.on('--mathjax', 'Enable MathJax (renders mathematical equations).',
+    'By default, uses the \'TeX-AMS-MML_HTMLorMML\' config with the \'autoload-all\' extension.') do
     wiki_options[:mathjax] = true
+    wiki_options[:mathjax_config] = 'mathjax.config.js'
   end
-  opts.on("--irb", "Launch Gollum in 'console mode', with a predefined API.") do
+  opts.on('--critic-markup', 'Enable support for annotations using CriticMarkup.') do
+    wiki_options[:critic_markup] = true
+  end
+  opts.on('--irb', 'Launch Gollum in \'console mode\', with a predefined API.') do
     options[:irb] = true
   end
-  
-  opts.separator ""
-  opts.separator "  Minor:"
-  
-  opts.on("--h1-title", "Use the first '<h1>' as page title.") do
+
+  opts.separator ''
+  opts.separator '  Minor:'
+
+  opts.on('--h1-title', 'Use the first \'<h1>\' as page title.') do
     wiki_options[:h1_title] = true
   end
-  opts.on("--show-all", "Also show files in the file view. By default, only valid pages are shown.") do
-    wiki_options[:show_all] = true
+  opts.on('--no-display-metadata', 'Do not render metadata tables in pages.') do
+    wiki_options[:display_metadata] = false
   end
-  opts.on("--collapse-tree", "Collapse the tree, when file view is opened. By default, the tree is expanded.") do
-    wiki_options[:collapse_tree] = true
+  opts.on('--user-icons [MODE]', [:gravatar, :identicon], 'Use specific user-icons for history view.',
+    'Can be set to \'gravatar\' or \'identicon\'. Default: standard avatar.') do |mode|
+    wiki_options[:user_icons] = mode.to_s
   end
-  opts.on("--user-icons [MODE]", [:gravatar, :identicon, :none], "Use specific user-icons for history view.",
-    "Can be set to 'gravatar', 'identicon' or 'none'. Default: 'none'.") do |mode|
-    wiki_options[:user_icons] = mode
+  opts.on('--template-dir [PATH]', 'Specify custom mustache template directory.') do |path|
+    wiki_options[:template_dir] = path
   end
-  opts.on("--mathjax-config [FILE]", "Specify path to a custom MathJax configuration.",
-    "If not specified, uses the '<git-repo>/mathjax.config.js' file.") do |file|
-    wiki_options[:mathjax_config] = file || 'mathjax.config.js'
+  opts.on('--template-page', 'Use _Template in root as a template for new pages.') do
+    wiki_options[:template_page] = true
   end
-  opts.on("--plantuml-url [URL]", "Sets the PlantUML server endpoint.") do |url|
-    wiki_options[:plantuml_url] = url
+  opts.on('--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.') do
+    wiki_options[:case_insensitive_tag_lookup] = true
+    wiki_options[:global_tag_lookup] = true
+    wiki_options[:hyphened_tag_lookup] = true
   end
-  opts.on("--template-dir [PATH]", "Specify custom mustache template directory.") do |path|
-    wiki_options[:template_dir] = path
+  opts.on('--emoji', 'Parse and interpret emoji tags (e.g. :heart:) except when the leading colon is backslashed (e.g. \\:heart:).') do
+    wiki_options[:emoji] = true
   end
-  
-  opts.separator ""
-  opts.separator "  Common:"
-  
-  opts.on("--help", "Display this message.") do
+  opts.separator ''
+  opts.separator '  Common:'
+
+  opts.on('--help', 'Display this message.') do
     puts opts
     exit 0
   end
-  opts.on("--version", "Display the current version of Gollum.") do
-    puts "Gollum " + Gollum::VERSION
+  opts.on('--version', 'Display the current version of Gollum.') do
+    puts 'Gollum ' + Gollum::VERSION
+  end
+  opts.on('--versions', 'Display the current version of Gollum and auxiliary gems.') do
+    require 'gollum-lib'
+    puts 'Gollum ' + Gollum::VERSION
+    puts "Running on: #{RUBY_PLATFORM} with Ruby version #{RUBY_VERSION}"
+    puts 'Using:'
+    loaded_gemspecs =  Gem.loaded_specs
+    gollum_gems = ['gollum-lib', 'gollum-rjgit_adapter', 'rjgit', 'gollum-rugged_adapter', 'rugged']
+    puts Gem.loaded_specs.select{|name, spec| gollum_gems.include?(name)}.map {|name, spec| "#{name} #{spec.version}"}
+    puts "Markdown rendering gem: #{GitHub::Markup::Markdown.implementation_name}"
+    puts 'Other renderering gems:'
+    renderer_gems = ['RedCloth', 'org-ruby', 'creole', 'asciidoctor', 'wikicloth']
+    renderer_gems.each do |renderer|
+      begin
+        require renderer
+      rescue LoadError
+      end
+    end
+    results = Gem.loaded_specs.select{|name, spec| renderer_gems.include?(name)}.map {|name, spec| "#{name} #{spec.version}"}
+    puts results.empty? ? 'none' : results
     exit 0
   end
-  
-  opts.separator ""
+
+
+  opts.separator ''
 end
 
 # Read command line options into `options` hash
 begin
   opts.parse!
-rescue OptionParser::InvalidOption
-  puts "gollum: #{$!.message}"
-  puts "gollum: try 'gollum --help' for more information"
+rescue OptionParser::InvalidOption => e
+  puts "gollum: #{e.message}"
+  puts 'gollum: try \'gollum --help\' for more information'
   exit
 end
 
@@ -210,28 +242,23 @@ if options[:irb]
     if !wiki.exist? then
       raise Gollum::InvalidGitRepositoryError
     end
-    if wiki_options[:plantuml_url]
-      Gollum::Filter::PlantUML.configure do |config|
-        puts "Using #{wiki_options[:plantuml_url]} as PlantUML endpoint"
-        config.url = wiki_options[:plantuml_url]
-      end
-    end
+
     puts
-    puts "Loaded Gollum wiki at:"
+    puts 'Loaded Gollum wiki at:'
     puts "#{File.expand_path(gollum_path).inspect}"
     puts
-    puts "Example API calls:"
+    puts 'Example API calls:'
     puts %(    page = wiki.page('page-name'))
     puts %(    # => <Gollum::Page>)
     puts
     puts %(    page.raw_data)
-    puts %(    # => "# My wiki page")
+    puts %(    # => '# My wiki page')
     puts
     puts %(    page.formatted_data)
-    puts %(    # => "<h1>My wiki page</h1>")
+    puts %(    # => '<h1>My wiki page</h1>')
     puts
-    puts "Full API documentation at:"
-    puts "https://github.com/gollum/gollum-lib"
+    puts 'Full API documentation at:'
+    puts 'https://github.com/gollum/gollum-lib'
     puts
     IRB.start_session(binding)
   rescue Gollum::InvalidGitRepositoryError, Gollum::NoSuchPathError
@@ -240,6 +267,7 @@ if options[:irb]
   end
 else
   require 'gollum/app'
+  Precious::App.set(:environment, ENV.fetch('RACK_ENV', :production).to_sym)
   Precious::App.set(:gollum_path, gollum_path)
   Precious::App.set(:wiki_options, wiki_options)
   Precious::App.settings.mustache[:templates] = wiki_options[:template_dir] if wiki_options[:template_dir]
@@ -251,13 +279,6 @@ else
     require cfg
   end
 
-  if wiki_options[:plantuml_url]
-    Gollum::Filter::PlantUML.configure do |config|
-      puts "Using #{wiki_options[:plantuml_url]} as PlantUML endpoint"
-      config.url = wiki_options[:plantuml_url]
-    end
-  end
-
   base_path = wiki_options[:base_path]
 
   if base_path.nil?
@@ -268,7 +289,7 @@ else
     class MapGollum
       def initialize(base_path)
         @mg = Rack::Builder.new do
-          
+
           map "/#{base_path}" do
             run Precious::App
           end
@@ -278,7 +299,7 @@ else
           map '/*' do
             run Proc.new { [302, { 'Location' => "/#{base_path}" }, []] }
           end
-          
+
         end
       end
 
@@ -286,7 +307,7 @@ else
         @mg.call(env)
       end
     end
-    
+
     # Rack::Handler does not work with Ctrl + C. Use Rack::Server instead.
     Rack::Server.new(:app => MapGollum.new(base_path), :Port => options[:port], :Host => options[:bind]).start
   end