adwiki

autodafe component for generating documentation

ADWiki

ADWiki is a system to display JavaScript documentation online. Your code should be documented by JSDoc rules.

##Demo

Live demo is here (you can see the source code of that file here) There is also a blog system to write articles for your project on the same site.

For example the site autodafe.ws (code on github) uses only ADWiki

##Installation

ADWiki uses nodejs as engine and DBMS MySQL The simplest way to install ADWiki is to use npm

First, create a folder for your project documentation site

$ mkdir your_project_docs
$ cd your_project_docs

Then install ADWiki

$ npm install adwiki

Make sure you are running mysql server

$ sudo service mysql start

Run a script to prepare DB and make configuration file

$ node node_modules/adwiki/install

It will be necessary to enter settings for DB connection (specified user must have permissions to create DB schemas)

##Configurations

You can adjust your project changing settings in your_project_docs/index.js

###http_port default: 3000

The HTTP port to server starts on.

###user default: "admin"

Administrator nickname. Administrator can create, edit and remove an articles on the site.

###password default: ""

Admin password

###project.path default: ""

It's a directory which recursive search of documented files start from

###project.start_page default: "About project"

The title of article which is shown on the site main page. There is a blank space because the article does not exist initially. So you should login in the site using login and password above and create that article.

###project.name default: "The project"

Project name

###project.description default: "project description"

Short project description

###project.twitter default: ""

Link to your project on twitter. A twitter bird appears on the site top panel if the link is specified.

###project.github default: ""

Link to your project on GitHub. It appears on the site top panel

###project.copy default: ""

Copyright is in the footer of every site page.

###project.author default: ""

Author of a project.

###db A database connection configuration. By default there are settings you entered while the site installation

##Advancing settings ADWiki uses nodejs framework Autodafe (link to documentation) And to quick change the site appearance just edit the templates in adwiki/views folder

##Feedback If you found an error or you have any questions or suggestions, please feel free to contact us at balakirev.andrey@gmail.com and balakirev.vladimir@gmail.com. We also can help you to organize your project documentation.

The project on twitter @node_autodafe