forked from nitrogen/nitrogen_core
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCOMPILE_DOCS
More file actions
24 lines (13 loc) · 695 Bytes
/
COMPILE_DOCS
File metadata and controls
24 lines (13 loc) · 695 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
COMPILING THE NITROGEN DOCUMENTATION
Compiling the documentation uses Org-mode for Emacs and a simple Perl script
for adding Disqus comments.
Editing the HTML is not recommended, as the org-mode compiler just overwrites
all HTML anyway. Instead, edit the org-mode files found in doc/org-mode.
Make sure you have emacs installed, with htmlize (version 1.34 or later),
erlang-mode, and org-mode installed.
On Ubuntu, these packages can all be installed with:
sudo apt-get install emacs erlang-mode org-mode emacs-goodies-el
Then you can compile the docs from the command line with
$ make docs
Also worth noting is that the Disqus comment injection script expects perl to
be in the PATH