[ANN] dokkit 0.4.1 released!

Discussion in 'Ruby' started by Andrea Fazzi, Jul 27, 2008.

  1. Andrea Fazzi

    Andrea Fazzi Guest

    Hi Folks,

    version 0.4.1 of dokkit has been released!


    1 Changes from version 0.4.0
    ============================

    * added support for postfiltering (now erb processing is done in the
    postfiltering step)
    * added experimental support for tidy postfilter

    Postfiltering is accessible through postfilter configuration key.

    Example:

    ---
    format:
    - text
    - latex
    - html:
    postfilter:
    - erb
    - tidy
    ---

    Content of the document.

    The example above will render the document producing plain text, latex
    and html output. In particular, the html output will be postprocessed by
    erb and tidy filters.


    2 What's dokkit?
    ================

    dokkit is a document generator written in ruby that is suitable for
    static websites generation too.

    dokkit uses formatters like deplate[1] and maruku[2] to generate
    documents in a large variety of output formats.

    dokkit's features are:

    * a smart building system based on rake[3]
    * a templating system based on ERB[4]
    * a flexible configuration system based on YAML[5] 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
    the 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

    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 latex 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 aims to be modular and extensible: you can add new formatters and
    helpers and easily extend document functionalities.

    See dokkit website[6] and visit the google group[7] for further
    informations and tutorials.


    3 Installation
    ==============

    From rubygems:

    sudo gem install dokkit

    From subversion repository:

    svn co http://dokkit.rubyforge.org/svn/dokkit-core/trunk/


    4 Usage
    =======

    dokkit simple
    cd simple/
    rake

    [1] http://deplate.sf.net/
    [2] http://maruku.rubyforge.org/
    [3] http://rake.rubyforge.org/
    [4] http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/
    [5] http://yaml4r.sourceforge.net/
    [6] http://dokkit.rubyforge.org/
    [7] http://groups.google.com/group/dokkit-forum

    ---

    This announce has been generated with dokkit on Sun Jul 27 13:18:25
    +0000 2008
    Andrea Fazzi, Jul 27, 2008
    #1
    1. Advertising

Want to reply to this thread or ask your own question?

It takes just 2 minutes to sign up (and it's free!). Just click the sign up button to choose a username and then you can ask your own questions on the forum.
Similar Threads
  1. Andrea Fazzi

    [ANN] dokkit 0.3.0 released

    Andrea Fazzi, Mar 31, 2008, in forum: Ruby
    Replies:
    0
    Views:
    103
    Andrea Fazzi
    Mar 31, 2008
  2. Andrea Fazzi

    [ANN] dokkit 0.4.0 released!

    Andrea Fazzi, Jul 22, 2008, in forum: Ruby
    Replies:
    0
    Views:
    94
    Andrea Fazzi
    Jul 22, 2008
  3. Andrea Fazzi

    [ANN] dokkit 0.4.2 released

    Andrea Fazzi, Aug 5, 2008, in forum: Ruby
    Replies:
    2
    Views:
    93
    Andrea Fazzi
    Aug 5, 2008
  4. Andrea Fazzi

    [ANN] dokkit 0.4.3 released

    Andrea Fazzi, Aug 6, 2008, in forum: Ruby
    Replies:
    0
    Views:
    75
    Andrea Fazzi
    Aug 6, 2008
  5. Andrea Fazzi

    [ANN] dokkit 0.4.4 released

    Andrea Fazzi, Aug 10, 2008, in forum: Ruby
    Replies:
    0
    Views:
    113
    Andrea Fazzi
    Aug 10, 2008
Loading...

Share This Page