Skip to content

Commit 2d2998f

Browse files
committed
README: update general doc
Signed-off-by: Eduardo Silva <[email protected]>
1 parent cbb3c0e commit 2d2998f

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
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.
44

5+
## Requirements
6+
7+
This documentation is generated using [Gitbook](http://gitbook.io), so the following tools needs to be installed:
8+
9+
### NPM
10+
11+
```
12+
$ sudo apt-get install npm
13+
```
14+
15+
### Gitbook
16+
17+
```shell
18+
$ sudo npm install gitbook
19+
$ sudo npm install gitbook-plugin-richquotes
20+
```
21+
522
## How the documentation is built
623

724
All documentation is made in GIT Flavored Markdown format and is rendered using the [Gitbook](https://github.com/GitbookIO/gitbook) tool. To generate a HTML documenation from this source please issue the following command:
@@ -10,4 +27,4 @@ All documentation is made in GIT Flavored Markdown format and is rendered using
1027
$ gitbook serve -p 9000 src/
1128
```
1229

13-
Then point your browser at [http://127.0.0.1:9000/] to see the HTML documents. For more options check the Gitbook help.
30+
Then point your browser at http://127.0.0.1:9000/ to see the HTML documents. For more options check the Gitbook help.

src/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* Mimetypes
1111
* Plugins
1212
* [IPv6](configuration/ipv6.md)
13+
* Memory Allocator
1314
* [Virtual Hosts](virtualhosts/README.md)
1415
* [Configuring](virtualhosts/configuring.md)
1516
* [Plugins](plugins/README.md)

0 commit comments

Comments
 (0)