Node.js Manual & Documentation (.pdf, .mobi, .epub)
TeX JavaScript
Latest commit 0e1fba7 Jun 27, 2015 @zemirco add smalloc
Permalink
Failed to load latest commit information.
epub add smalloc Jun 27, 2015
markdown add new markdown Jun 27, 2015
mobi add smalloc Jun 27, 2015
pdf add smalloc Jun 27, 2015
.gitignore ignore .idea Mar 12, 2013
History.md update history and readme Oct 20, 2013
README.md update version in readme Jun 27, 2015
app.js js version Jan 6, 2013
cleanTex.js jshint Jan 6, 2013
epub.js jshint Jan 6, 2013
mobi.js mobi v0.8.16 Jan 6, 2013
package.json all new 0.10.25 Feb 7, 2014
toc.json add smalloc Jun 27, 2015

README.md

Node.js Manual & Documentation (.pdf, .mobi, .epub)

It all started with my desire to have a nicely formatted version of the node.js manual & documentation as a printable pdf with a cover, table of content, indented code blocks and so on. Then came requests for a .mobi (Kindle) file and an .epub (iOS, Android and more) file.

Of course the whole creation and conversion process is written in node.js.

Current version of node.js in the docs: 0.12.5

How to use

Just check out the different folders or download directly:

Create your own files

You need to have pandoc installed on your system. All the markdown files from the node repository should be placed inside the markdown folder.

Create .pdf

  1. Use node app.js to create the .tex files
  2. Manually edit the few files as shown in all.tex (or run node cleanTex.js)
  3. Create the pdf with pdfLaTeX

Customizing

Use options.tex and run latex to customize your own manual.

Create .epub

  1. Run node epub.js to create the file

Create .mobi

The .mobi version is created from the .epub file which gives better results compared to converting the .pdf file.

  1. Download kindlegen from this repository or directly from Amazon
  2. Run node mobi.js to create the file. The file is located inside the epub folder

License

Copyright (C) 2014 [Mirco Zeiss](mailto: mirco.zeiss@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.