Next Generation Dojo Documentation Project
OTHER License
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:
This is released under the same "New" BSD License as the Dojo Toolkit:
(Note: It is not licensed under the AFL 2.1)
Additional libraries are licensed and copyrighted by their respective owners.
npm
)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
.
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, npm
and installed.
You will also need cpm or volo to install the AMD dependencies.
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
Install AMD dependencies.
Build the client library build:
src/util/buildScripts/build.sh --profile dojoment.profile.js
Start the server:
node server
You will get a message indicating that the server is running and what port it is running on.
In order to generate all the reference documentation