lbod / dojoment

Next Generation Dojo Documentation Project

dojoment

dojoment is an experimental project looking at the possibility of a markdown based community editable documentation wiki which can be used instead of the current solution which is based on reStructuredText.

The main objectives of this project are:

• Base the entire solution on JavaScript (because that is what we are about)
• Leverage as much of the Dojo Toolkit as possible (eat our own dogfood)
• Adopt markdown as the primary markup
• Extend the markdown syntax, if required, to provide live examples
• Provide a community editable wiki
• Make it easier to generate final documentation for the website
• Fully integrate into git and GitHub for documentation storage
• Assess the suitability to be able to create Dojo Tutorials
• Align better with the Dojo Inline Documentation Parser

Licensing

This is released under the same "New" BSD License as the Dojo Toolkit:

• The "New" BSD License

(Note: It is not licensed under the AFL 2.1)

Additional libraries are licensed and copyrighted by their respective owners.

Requirements

• Node.js - Requires v0.8 or later (including npm)
• Dojo Toolkit - Requires v1.8.0 or later
• express - Requires v3.0.0 or later
• jade - Requires v0.27.2 or later
• marked - Requires v0.2.5 or later (customized)
• highlight.js - Requires v7.1.0 or later
• stylus - Requires v0.29.0 or later
• Font-Awesome - Requires v2.0 or later

The Dojo Toolkit and Font-Awesome and the customized fork of marked are installed as submodules and can be managed by git. express, jade, highlight.js and stylus are installed as node modules and can be managed via npm.

Installation

Experimental does mean experimental, this is under heavy development and I may not remember to update the README every time.

• Ensure you have git, Node.js and npm installed.
• Clone the repository recursively:

git clone --recursive https://github.com/kitsonk/dojoment.git

• Update the config.json.
• Update the reference docs repository:

cd dojoment/refdocs
git pull

• Build the client library build:

cd ..
src/util/buildScripts/build.sh --profile dojoment.profile.js

• Start the server:

node server.js

You will get a message indicating that the server is running and what port it is running on.