Contents

middleman-pagegroups readme
---------------------------
[![Gem Version](https://badge.fury.io/rb/middleman-pagegroups.svg)](https://badge.fury.io/rb/middleman-pagegroups)


`middleman-pagegroups`

 : This gem provides advanced navigation tools and helpers for grouping pages
   by topic and navigating between them. It includes support for tables of
   content, related pages, breadcrumbs, and more.

   It is standalone and can be used in any **Middleman** project.


Documentation One-Pager:
------------------------

Have a sneak peak at the API without installing anything.

- [On Github](http://htmlpreview.github.io/?https://github.com/middlemac/middleman-pagegroups/blob/master/README_doc.html)
- [Locally](README_doc.html)


Install the Gem
---------------

Install the gem in your preferred way, typically:

~~~ bash
gem install middleman-pagegroups
~~~

From git source:

~~~ bash
rake install
~~~


Documentation
-------------

The complete documentation leverages the features of this gem in order to better
document them. Having installed the gem, read the full documentation in your
web browser:

~~~ bash
middleman-pagegroups documentation
cd middleman-pagegroups-docs/
bundle install
bundle exec middleman server
~~~
   
And then open your web browser to the address specified (typically
`localhost:4567`).


Middlemac
---------

This Middleman extension is a critical part of
[**Middlemac**](https://github.com/middlemac), the Mac OS X help building system
for Mac OS X applications. However this gem is not Mac OS X specific and can be
useful in any application for which you want to provide structure and
navigation.


License
-------

MIT. See [`LICENSE.md`](LICENSE.md).


Changelog
---------

See [`CHANGELOG.md`](CHANGELOG.md) for point changes, or simply have a look at
the commit history for non-version changes (such as readme updates).

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
middleman-pagegroups-1.0.10	README.md
middleman-pagegroups-1.0.9	README.md
middleman-pagegroups-1.0.8	README.md
middleman-pagegroups-1.0.7	README.md