hologram 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44fd37424aab536da5370b6abfbc8c5a68822f13
-  data.tar.gz: 04896bbf8a01403e51749ba13b2f090fb2472c10
+  metadata.gz: 4dc92f494ebbef69183d26491a4402f70eda4905
+  data.tar.gz: 8eb5523c6b4cdcbf52016cbfef86079ce19ec308
 SHA512:
-  metadata.gz: 0a356a2e50be8c1e95c3912482d29cfb400a6bff706343fd69a1791d37cab3f4224d1084094634303b714a11967b1c60d07a9946bc45928149104c392acb9ccc
-  data.tar.gz: c6a79b44f60c67445b05f084c4d6efe62a7442f136c2596e9c9db571f536fb95b615b99bc3db528bd695b9516b64e481bc0e4542232fefedf6dba49a43d805e8
+  metadata.gz: 34bab501f8b586ac7cd351111543ca8618a96d065057568d290988aa7a453ea0c2561942800cee4bd76db9404436d829d2d13f0f102dff79195774a696e9c1ff
+  data.tar.gz: 384ffdfe89e4830b6b4bc42a21d4f94d54ad15c31d59c68643ed649e8a4e0292c838c8602956f4c3ed691c98db3c290919e3f24c7bf9dec4125f2cee395c2252

data/README.md

@@ -49,6 +49,9 @@ Your config file needs to contain the following key/value pairs
   RedCarpet::Render::HTML class. Use this for when you need
   additional classes or html tags for different parts of the page.
 
+* **index**: (optional) this is a category that will be used as the
+  index.html. 
+
 * **dependencies**: a **list** of relative pathes to a folderes containing any dependencies your style guide has.
 These folders will be copied over into the documentation output directory.
 PUT THE CSS/JS THAT IS ACTUALLY BEING DOCUMENTED HERE

data/lib/hologram.rb

@@ -104,6 +104,17 @@ module Hologram
       process_dir(input_directory)
 
       build_pages_from_doc_blocks(@doc_blocks)
+
+      # if we have an index category defined in our config copy that
+      # page to index.html
+      if config['index'] 
+        if @pages.has_key?(config['index'] + '.html')
+          @pages['index.html'] = @pages[config['index'] + '.html']
+        else
+          display_warning "Could not generate index.html, there was no content generated for the category #{config['index']}"
+        end
+      end
+
       write_docs(output_directory, doc_assets)
 
       # Copy over dependencies

data/lib/hologram/version.rb

@@ -25,5 +25,5 @@
 # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module Hologram
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hologram
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - JD Cantrell
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.7
 - !ruby/object:Gem::Dependency
   name: pygments.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Build doc type things
@@ -89,7 +89,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,17 +109,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Build document type things.