Skip to content
Newer
Older
100644 32 lines (20 sloc) 989 Bytes
597ca14 @jfhbrook [minor] Forgot "Appendix" headings for appendices
jfhbrook authored
1 # Appendix: Building the Nodejitsu Handbook
023403b @jfhbrook [fix] anchor tags in appendices now consistent, after headers for ron…
jfhbrook authored
2 <a name='apx:build'></a>
be5daac @jfhbrook A short appendix on building the handbook
jfhbrook authored
3
4 ## Dependencies
5
6 The build process for the handbook has a few dependencies:
7
8 * [make](http://en.wikipedia.org/wiki/Make_\(software\))
9 * [ronn](https://github.com/rtomayko/ronn)
10 * [htmldoc](http://www.htmldoc.org/)
11
12 Make and htmldoc should be available via your operating system's package manager
13 (ie. apt-get). ronn is available on [rubygems](http://rubygems.org/), which in
14 turn should be available via your operating system's package manager as well. On
55366e8 @AvianFlu Regenerated book
AvianFlu authored
15 Debian-based systems, the rubygems package does not add its bin folder
16 (`/var/lib/gems/1.8/bin`) to your $PATH variable, so add something
be5daac @jfhbrook A short appendix on building the handbook
jfhbrook authored
17 like:
18
138ed62 @jfhbrook [doc] A formatting issue in the appendix just got fixed.
jfhbrook authored
19 PATH="/var/lib/gems/1.8/bin:$PATH"
20
be5daac @jfhbrook A short appendix on building the handbook
jfhbrook authored
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.