middleman-pagegroups readme
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.
Install the Gem
Install the gem in your preferred way, typically:
gem install middleman-pagegroups
From git source:
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:
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, 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
.
Changelog
See CHANGELOG.md
for point changes, or simply have a look at
the commit history for non-version changes (such as readme updates).