Browse files

Add config example

  • Loading branch information...
1 parent 79bb5c1 commit 213e2bb4323e4bff6b470e890783e013e2c00310 @bootstraponline bootstraponline committed Nov 7, 2012
Showing with 32 additions and 0 deletions.
  1. +4 −0 README.md
  2. +28 −0 config.rb
View
4 README.md
@@ -532,6 +532,10 @@ Your Rack middleware can pass author details to Gollum in a Hash in the session
## WINDOWS FILENAME VALIDATION
Note that filenames on windows must not contain any of the following characters `\ / : * ? " < > |`. See [this support article](http://support.microsoft.com/kb/177506) for details.
+## CONFIG FILE
+
+Gollum optionaly takes a `--config file`. See [config.rb](https://github.com/github/gollum/blob/master/config.rb) for an example.
+
## CONTRIBUTE
If you'd like to hack on Gollum, start by forking my repo on GitHub:
View
28 config.rb
@@ -0,0 +1,28 @@
+# Example gollum config
+# gollum ../wiki --config config.rb
+#
+# or run from source with
+#
+# bundle exec bin/gollum ../wiki/ --config config.rb
+
+# Remove const to avoid
+# warning: already initialized constant FORMAT_NAMES
+#
+# only remove if it's defined.
+# constant Gollum::Page::FORMAT_NAMES not defined (NameError)
+Gollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES
+# limit to one format
+Gollum::Page::FORMAT_NAMES = { :markdown => "Markdown" }
+
+=begin
+Valid formats are:
+{ :markdown => "Markdown",
+ :textile => "Textile",
+ :rdoc => "RDoc",
+ :org => "Org-mode",
+ :creole => "Creole",
+ :rest => "reStructuredText",
+ :asciidoc => "AsciiDoc",
+ :mediawiki => "MediaWiki",
+ :pod => "Pod" }
+=end

0 comments on commit 213e2bb

Please sign in to comment.