dokkit

dokkit by Andrea Fazzi http://dokkit.rubyforge.org

== DESCRIPTION:

dokkit is a document generator that is suitable for static website generation too. dokkit uses formatters like deplate and maruku to generate output in tex, html and plain text.

With dokkit you can:

• generate static websites

• generate many types of documents in many formats

• write your documents using a simple wiki syntax and obtain high quality output (with pdflatex)

• generate different output formats from the same source document

• use models to quickly generate the documents you want (technical report, howto, guides, presentation, website, etc.)

• simply derive new documentation models from the existing ones

• simply modify existing models to fit your needs

For more information about dokkit visit the website[http://dokkit.rubyforge.org/]

== FEATURES/PROBLEMS:

dokkit's features are:

• a smart building system based on rake

• a templating system based on ERB

• a flexible configuration system based on YAML that supports shared configuration files and ‘in header’ configuration

• an extensible formatting system that uses deplate and maruku as built-in filters

• convention over configuration: for example, you don’t need to give a layout name to use if a layout with the same name of the processed document is found in doc/layouts folder

• support for nested layouts

• support for partials

• support for caching

== SYNOPSIS:

To create a new documentation environment in run:

dokkit

== REQUIREMENTS:

• deplate >= 0.8.0
• maruku => 0.5.9
• rake >= 0.8.1

== INSTALL:

sudo gem install dokkit

== QUICK START

dokkit mydocument cd mydocument rake

== LICENSE:

Copyright (c) 2008 Andrea Fazzi

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.