Skip to content
Documentation generator based on a fluent data model rather than hard-coded content types.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
SERVER.md
yarrow.gemspec

README.md

Yarrow

Gem Version Build Status Dependency Status Code Climate Coverage Status

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.

Installation

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 bundle:

gem 'yarrow'

Status

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.

Roadmap

A rough sketch of the project direction.

Version Features
0.3 Local dev server and asset pipeline
0.4 Default media type mapping, collector, markup converters
0.5 Content model/object mapping, template/site context
0.6 HTML tag helpers, default layout templates
0.7 Rake integration, task library
0.8 Generic command line runner
0.9 Refactoring, performance fixes, lock down API

License

MIT. See the LICENSE file in the source distribution.

Contact

Author: Mark Rickerby me@maetl.net

Something went wrong with that request. Please try again.