Sha256: 7e829916233fe4291da0dee10eef7a0b70f19b711642d457f5e33734f87ca7c2

Contents?: true

Size: 1.31 KB

Versions: 2

Compression:

Stored size: 1.31 KB

Contents

# nanoc-toolbox

!!! THIS LIBRARY IS STILL UNDER DEVELOPMENT !!!

## Presentation

The nanoc-toolbox is a collection of filters and helpers for the static site generator tool nanoc.

## Features

* Navigation Helper
* Gravatar Helper
* HtmlTag Helper

* AddSection Filter
* HtmlTidy Filter

## Requirements

* nanoc3
* Nokogiri

## Installation

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
    include Nanoc::Toolbox::Helpers::Gravatar

## 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.

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
nanoc-toolbox-0.0.5 README.md
nanoc-toolbox-0.0.4 README.md