gollum-site 0.0.2 → 0.0.3

data/README.md

@@ -3,7 +3,7 @@ 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
 
@@ -11,6 +11,20 @@ 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:
@@ -53,6 +67,15 @@ 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

data/bin/gollum-site

@@ -16,6 +16,7 @@ Basic Command Line Usage:
 
         generate      Generate a static site
         serve         Start a web server to view generated site
+        import        Import the default layout into the current wiki
 
 Options:
 HELP
@@ -93,6 +94,13 @@ when 'serve'
 
   trap("INT") { s.shutdown }
   t.join()
+when 'import'
+  dir = Gollum::Site.default_layout_dir()
+  layout = ::File.join(dir, "_Layout.html")
+  css = ::File.join(dir, "css")
+  javascript = ::File.join(dir, "javascript")
+  FileUtils.cp_r([layout, css, javascript], '.')
+  puts "The default layout has been imported. Don't forget to commit these changes."
 else
   puts opts
   exit

data/lib/gollum-site/site.rb

@@ -1,5 +1,9 @@
 module Gollum
   class Site
+    def self.default_layout_dir()
+      ::File.join(::File.dirname(::File.expand_path(__FILE__)), "layout")
+    end
+
     attr_reader :output_path
 
     def initialize(wiki, options = {})
@@ -35,12 +39,12 @@ module Gollum
       end
 
       if layouts["."].nil? and @include_default_layout
-        dir = ::File.dirname(::File.expand_path(__FILE__))
-        default_layout = ::File.join(dir, "layout", "_Layout.html")
+        dir = Gollum::Site.default_layout_dir()
+        default_layout = ::File.join(dir, "_Layout.html")
         layout = ::Liquid::Template.parse(IO.read(default_layout))
         layouts["."] = layout
-        css = ::File.join(dir, "layout", "css")
-        javascript = ::File.join(dir, "layout", "javascript")
+        css = ::File.join(dir, "css")
+        javascript = ::File.join(dir, "javascript")
         FileUtils.cp_r([css, javascript], @output_path)
       end
 

data/lib/gollum-site/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   class Site
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gollum-site
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Daniel Reverri
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-21 00:00:00 -07:00
+date: 2010-10-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency