README.md in gollum-site-0.0.2 vs README.md in gollum-site-0.0.3
- old
+ new
@@ -1,18 +1,32 @@
gollum-site -- A static site generator for Gollum
=================================================
## Description
-Generates a static site from a Gollum Wiki.
+Generates a static site from a [Gollum](http://github.com/github/gollum) Wiki.
## Installation
The easiest way to install gollum-site is with RubyGems:
$ [sudo] gem install gollum-site
+## Supported formats
+
+Gollum supports several formats for wiki text. In order to generate the various
+supported formats certain dependencies must be met:
+
+* [ASCIIDoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc`
+* [Creole](http://wikicreole.org/) -- `gem install creole`
+* [Markdown](http://daringfireball.net/projects/markdown/) -- `gem install rdiscount`
+* [Org](http://orgmode.org/) -- `gem install org-ruby`
+* [Pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML` comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
+* [RDoc](http://rdoc.sourceforge.net/)
+* [ReStructuredText](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
+* [Textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
+
## Usage
Static sites can be generated using the executable provided:
$ gollum-site generate
@@ -50,9 +64,18 @@
root layout. The default layout is the same used in gollum without the edit
features. It's possible to generate a site without the default template using
the "--no_default_layout" option:
$ gollum-site --no_default_layout generate
+
+## Import
+
+The gollum-site executable provides the ability to import the default layout to
+the current wiki. The import command will copy the required "_Layout.html", css
+and javascript to the current wiki. These files must be committed to the wiki
+repository before the 'generate' command will recognize them.
+
+ $ gollum-site import
## Example
To see gollum-site in action, let's use it to generate a static site from a
Gollum Wiki. For this example I will use the Radiant wiki: