README.txt in dokkit-0.4.4 vs README.txt in dokkit-0.5.0

- old
+ new

@@ -2,38 +2,56 @@ by Andrea Fazzi http://dokkit.rubyforge.org == DESCRIPTION: -dokkit is a document generator. It was inspired by rote but now it is -completely independent from it. dokkit uses filters like deplate and -maruku to generate output in a large variety of formats (tex, html, -docbook, plain text, ...). +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 (html, tex, plain text, etc.) -* write your documents using a simple wiki syntax and obtain high quality output + +* 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, invoice, howto, guides, presentation, website, etc.) + +* 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 please execute: +For more information about dokkit visit the website[http://dokkit.rubyforge.org/] - dokkit --help - == FEATURES/PROBLEMS: -dokkit key features are: +dokkit's features are: -* a smart building system based on rake[http://rake.rubyforge.org] -* a documentation directory structure organized in pages, layouts, configuration files, resources +* a smart building system based on rake + * a templating system based on ERB -* a simple and flexible configuration system based on YAML + +* 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 <dirname> run: @@ -49,12 +67,12 @@ sudo gem install dokkit == QUICK START - $ dokkit mydocument - $ cd mydocument - $ rake + dokkit mydocument + cd mydocument + rake == LICENSE: Copyright (c) 2008 Andrea Fazzi