[ANN] dokkit 0.5.0

0 views
Skip to first unread message

andrea...@alca.le.it

unread,
Aug 27, 2008, 4:00:24 AM8/27/08
to ruby...@ruby-lang.org, dokkit...@googlegroups.com
dokkit version 0.5.0
by Andrea Fazzi
http://dokkit.rubyforge.org

== CHANGES

* huge code refactoring
* many bug fixes
* improved support for partial; now, by default, file name beginning
with an underscore are considered partials; partials search dir is
document dir
* new environment configuration dsl syntax; see setup.rb and
Dokkit::Environment::Helper

== DESCRIPTION

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

* 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

== QUICK START

dokkit mydocument
cd mydocument
rake

== DOWNLOAD/INSTALL

sudo gem install dokkit

Reply all
Reply to author
Forward
0 new messages