https://github.com/remogatto/dokkit-core

dokkit is a document generator written in ruby that is suitable for static websites generation too
https://github.com/remogatto/dokkit-core

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/remogatto/dokkit-core
• Owner: remogatto
• Created: 2008-10-13T17:11:47.000Z (about 16 years ago)
• Default Branch: master
• Last Pushed: 2008-12-14T22:04:01.000Z (about 16 years ago)
• Last Synced: 2024-04-26T04:04:48.357Z (9 months ago)
• Language: Ruby
• Homepage: http://dokkit.rubyforge.org/
• Size: 180 KB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.txt
  • Changelog: History.txt

Awesome Lists containing this project

README

        
dokkit

    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, ...).

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 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.)

* simply derive new documentation models from the existing ones

* simply modify existing models to fit your needs

For more information please execute:

  dokkit --help

== FEATURES/PROBLEMS:

  

dokkit key 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 templating system based on ERB

* a simple and flexible configuration system based on YAML

* support for partials

== 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 .