autodafe component for generating documentation
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)
You can adjust your project changing settings in
The HTTP port to server starts on.
Administrator nickname. Administrator can create, edit and remove an articles on the site.
It's a directory which recursive search of documented files start from
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.
default: "The project"
default: "project description"
Short project description
Link to your project on twitter. A twitter bird appears on the site top panel if the link is specified.
Link to your project on GitHub. It appears on the site top panel
Copyright is in the footer of every site page.
Author of a project.
A database connection configuration. By default there are settings you entered while the site installation
ADWiki uses nodejs framework Autodafe (link to documentation) And to quick change the site
appearance just edit the templates in
If you found an error or you have any questions or suggestions, please feel free to contact us at email@example.com and firstname.lastname@example.org. We also can help you to organize your project documentation.
The project on twitter @node_autodafe