dokkit [Ruby Documentation toolKit]

Documentation models

One of the key features of dokkit are documentation models. Using documentation models you can:

Basically, a documentation model is a collection of

organized in a structure of directories. This structure is reproduced in the destination directory specified as argument when the dokkit command is executed.

The syntax to create a documentation environment based on the modelname model is:

dokkit --model modelname destdir

The command above will create a new documentation environment based on modelname in the directory destdir.

If you want to install your own documentation model create a .dokkit folder in your home directory and place the model directory in it. Then, to check if you correctly installed the model, run:

dokkit --list

and see if the new documentation model is in the list.

Once you have installed your new documentation model, you can use it passing its name to the --model option.

The example below illustrates the creation process of a new model.


# EXAMPLE: Create a new documentation model

# cd into $HOME/.dokkit folder
cd
cd .dokkit/

# create models subdirectory
mkdir models
cd models

# create a new documentation model based on the built-in model
dokkit mymodel 

# modify mymodel in order to fit your needs ...

# use mymodel to create your new documentation environment
dokkit --model mymodel mydocument

Here below the currently available documentation models are listed. Click on the link to read more about a particular model.

simple
This model is builtin in the dokkit core distribution. To learn more about this model click here.