Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zemirco/nodejs-pdf-docs
Node.js Manual & Documentation (.pdf, .mobi, .epub)
https://github.com/zemirco/nodejs-pdf-docs
Last synced: 2 months ago
JSON representation
Node.js Manual & Documentation (.pdf, .mobi, .epub)
- Host: GitHub
- URL: https://github.com/zemirco/nodejs-pdf-docs
- Owner: zemirco
- Created: 2012-06-27T14:06:21.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-06-27T08:12:04.000Z (over 9 years ago)
- Last Synced: 2024-07-29T15:37:59.482Z (4 months ago)
- Language: TeX
- Homepage:
- Size: 38.3 MB
- Stars: 496
- Watchers: 26
- Forks: 87
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
README
# 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:
- [pdf](https://github.com/zeMirco/nodejs-pdf-docs/blob/master/pdf/all.pdf?raw=true)
- [epub](https://github.com/zeMirco/nodejs-pdf-docs/blob/master/epub/nodejs-manual.epub?raw=true)
- [mobi](https://github.com/zeMirco/nodejs-pdf-docs/blob/master/mobi/nodejs-manual.mobi?raw=true)
## Create your own files
You need to have [pandoc](http://johnmacfarlane.net/pandoc/) installed on your system. All the markdown files from the
[node repository](https://github.com/joyent/node) 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](http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000234621)
2. Run `node mobi.js` to create the file. The file is located inside the epub folder
## License
Copyright (C) 2014 [Mirco Zeiss](mailto: [email protected])
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.