zemirco / nodejs-pdf-docs Goto Github PK

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

JavaScript 0.44% TeX 99.56%

nodejs-pdf-docs's Introduction

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

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

Customizing

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

Create .epub

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.

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

License

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.

nodejs-pdf-docs's People

Contributors

Stargazers

Watchers

nodejs-pdf-docs's Issues

epub version error?

I tried to upload the .epub version to my google play books multiple times, but it kept throwing an error saying the book cannot be processed. I don't know much about ebooks, but might there be an issue here? I was trying top open the .epub file with Sigil on my Mac, but it crashed the app as well.

Update to node v4.4.4 (LTS)

update to current version

pdf created has no bookmarks

clone this repo, delete all markdown files, add markdown file from node v4.2.6.
run node app.js, then edit table of contents in pdf/all.tex to include new markdown files and delete non-existing markdown files.
run pdflatex all.tex to create pdf.
pdf has no bookmarks, contents page is blank.
working OS is Ubuntu 14.04 with pandoc and texlive installed.
is there something wrong with my processure? thx.

Update Document to current version

Hi Mr.zemirco
Today , Document is one of main source of knowledge for anyone who walk in path of science;
And your project is one of the useful tool for anyone who walk in this path;
I am sure you will read it and update it to the current version of node js.

update to v0.10.0

awesome

update to nodejs v. 6.1.0

Not sure how to update it to build the pdf.

Can someone help? Thx in advance

add history.md

Redirect loop for pdf download from README

When trying to download the pdf version using the URL https://github.com/zemirco/nodejs-pdf-docs/blob/master/pdf/all.pdf?raw=true , I get an error about a redirect loop in Chrome. I tested the download in curl and the 302 response has the same location as the original request, so I think Chrome is reporting the truth. Is there something I'm doing wrong?

Thanks!

what about a .mobi version?

would that be possible? thanks

latex errors

pandoc converts links from the .markdown files to latex commands like the following:

\hyperref[crypto\_crypto\_createcipher\_algorithm\_password]{createCipher()}

Creating the .pdf with this line causes the following error

! Missing \endcsname inserted.
<to be read again> 
               \protect 
l.202 ...rypto\_createcipher\_algorithm\_password]
                                              {createCipher()}
?

Editing the line by hand to the following allows latex to create the pdf without errors

\hyperref[crypto_crypto_createcipher_algorithm_password]{createCipher()}

Does anybody know how to overcome the editing by hand? I think it is a problem connected to the hyperref package

Please update to LTS 4.4.7 and 6.3.1 versions

Hi,

I'm interested in your repo. However, it is ~1year outdated. Please update to latest versions of NodeJS.

Thanks a heap!

Kind regards

zemirco / nodejs-pdf-docs Goto Github PK

nodejs-pdf-docs's Introduction

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

How to use

Create your own files

Create .pdf

Customizing

Create .epub

Create .mobi

License

nodejs-pdf-docs's People

Contributors

Stargazers

Watchers

Forkers

nodejs-pdf-docs's Issues

Recommend Projects

Recommend Topics

Recommend Org