Yarrow is a tool for generating well structured documentation from a variety of input sources.
Unlike most static site generators and code documentation tools, Yarrow is written with design and content-strategy in mind. It does not impose its own structure on your content. This makes it appropriate for building static sites and blogs as well as style guides and API docs.
Install the library and command line tool via RubyGems:
gem install yarrow
Or embed it in an existing Ruby project by adding the following line to the
Gemfile and running
Yarrow is an extraction from several existing private documentation projects. This repo is in alpha state, which means that many of the useful features are not yet folded into this codebase.
Yarrow is being slowly developed as a part-time project to scratch a few itches. New features and bugfixes are pushed straight to master, and releases of the Gem are kept more or less in sync with the planned roadmap.
A rough sketch of the project direction.
||Local dev server and asset pipeline|
||Default media type mapping, collector, markup converters|
||Content model/object mapping, template/site context|
||HTML tag helpers, default layout templates|
||Rake integration, task library|
||Generic command line runner|
||Refactoring, performance fixes, lock down API|
MIT. See the
LICENSE file in the source distribution.
Author: Mark Rickerby firstname.lastname@example.org