Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 32 lines (21 sloc) 0.961 kb
be5daac @jfhbrook A short appendix on building the handbook
jfhbrook authored
1 # Building the Nodejitsu Handbook
2
3 ## Dependencies
4
5 The build process for the handbook has a few dependencies:
6
7 * [make](http://en.wikipedia.org/wiki/Make_\(software\))
8 * [ronn](https://github.com/rtomayko/ronn)
9 * [htmldoc](http://www.htmldoc.org/)
10
11 Make and htmldoc should be available via your operating system's package manager
12 (ie. apt-get). ronn is available on [rubygems](http://rubygems.org/), which in
13 turn should be available via your operating system's package manager as well. On
14 Ubuntu systems, the rubygems package does not add its bin folder
15 (`/var/lib/gems/1.8/bin` in Karmic) to your $PATH variable, so add something
16 like:
17
18 '''
19 PATH="/var/lib/gems/1.8/bin:$PATH"
20 '''
21
22 to the end of your `~/.profile` file and activate it by running `. ~/.profile`.
23
24 ## Build Process
25
26 Once you've installed the dependencies, all you have to do is:
27
28 $ make
29
30 and the files `./book.md`, `book.pdf`, `book.html`, `API.md` and `ReadMe.md`
31 should all be generated.
Something went wrong with that request. Please try again.