asacamano / monkey-docs

Monkey Documentation Project

Monkey Documentation Project

Monkey is a fully featured HTTP Server for Linux. The present repository contains the official documentation for each Monkey version covering admistration topics and general tutorials to accomplish specific setups.

Requirements

This documentation is generated using Gitbook, so the following tools needs to be installed:

NPM

$ sudo apt-get install npm

Gitbook

$ sudo npm install gitbook
$ sudo npm install gitbook-plugin-richquotes

How the documentation is built

All documentation is made in GIT Flavored Markdown format and is rendered using the Gitbook tool. To generate a HTML documenation from this source please issue the following command:

$ gitbook serve -p 9000 src/

Then point your browser at http://127.0.0.1:9000/ to see the HTML documents. For more options check the Gitbook help.