nanoc-toolbox 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,9 @@
 pkg/*
 *.gem
 .bundle
+.DS_Store
+.autotest
+.idea
+.yardoc
+rdoc
+coverage

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+-
+CHANGELOG.MD
+LICENSE.md

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## developement
+
+* NEW:      README, LICENSE and CHANGELOG files
+* FIXED:    Correct the gemspec hompage, and removed rubyforge reference
+* CHANGED:  Cleanup on the navigation helper
+* NEW:      Add Yardoc
+* NEW:      RSPEC Test framework
+
+## Release 0.0.1
+
+* First Release

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    nanoc-toolbox (0.0.1)
+      nanoc (>= 3.1.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    cri (1.0.1)
+    nanoc (3.1.6)
+      nanoc3 (>= 3.1.6)
+    nanoc3 (3.1.6)
+      cri (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  nanoc (>= 3.1.6)
+  nanoc-toolbox!

data/LICENSE.md

@@ -0,0 +1,24 @@
+# License
+
+## (The MIT License)
+
+Copyright (c) 2011 Anouar ADLANI <anouar@adlani.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# nanoc-toolbox
+
+## Presentation
+
+The nanoc-toolbox is a collection of filters and helpers for the static site generator tool nanoc
+
+## Features
+
+* Navigation Helper
+
+## Requirements
+
+* nanoc3
+
+
+## Instalation
+
+To use the nanoc-toolbox, you have to start by installing the gem.
+
+    gem install nanox-toolbox
+
+Then require the project main file in your default.rb file in the lib directory of your nanoc project.
+
+    require "nanoc/toolbox"
+
+And the last step is to include the required helper or filter, anywhere in the lib directory of your lib directory.
+The usage wants you to put it in the default.rb or the helpers.rb file. 
+
+The following example shows a sample helpers_.rb file in the lib directory
+
+    # Default Helpers provided By Nanoc
+    include Nanoc3::Helpers::Blogging
+    include Nanoc3::Helpers::Breadcrumbs
+
+    # Custom Helpers
+    include Nanoc::Toolbox::Helpers::Navigation
+
+## Acknowledgments
+
+
+
+## Author
+
+* Anouar ADLANI <anouar@adlani.com>
+
+## Changelog
+
+See the CHANGELOG.rdoc file for details.
+
+
+## License
+
+Copyright (c) 2011 Anouar ADLANI, nanoc-toolbox is released under the MIT license.
+See the LICENSE.md file for details.