What’s dokkit?
dokkit is a document generator written in
ruby that is suitable for static websites generation too.
dokkit uses formatters like deplate
and maruku
to generate documents in a large variety of output
formats.
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 get high quality output
- generate different output formats from the same source document
- use models to quickly generate the documents you want (static websites, reports, howtos, guides, presentations, etc.)
- simply derive new documentation models from the existing ones
- simply modify existing models to fit your needs
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/layoutsfolder - support for nested layouts
- support for partials
- support for caching
dokkit aims to be modular and extensible: you
can easily add new formatters, helpers and document
classes.
To start playing with dokkit download
it and go to the tutorials page to learn how to use it.