https://github.com/jimschubert/masteringnode

Open source eBook for nodejs - written w/ markdown outputs to various formats (pdf, mobi, epub, html, etc)
https://github.com/jimschubert/masteringnode

Last synced: 16 days ago
JSON representation

Open source eBook for nodejs - written w/ markdown outputs to various formats (pdf, mobi, epub, html, etc)

• Host: GitHub
• URL: https://github.com/jimschubert/masteringnode
• Owner: jimschubert
• Fork: true (visionmedia/masteringnode)
• Created: 2011-03-13T06:25:16.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2012-02-20T19:00:12.000Z (over 12 years ago)
• Last Synced: 2024-08-01T12:30:42.238Z (4 months ago)
• Language: JavaScript
• Homepage: http://jimschubert.github.com/masteringnode/
• Size: 2.72 MB
• Stars: 26
• Watchers: 5
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Mastering Node

 Mastering node is an open source eBook by node hackers for node hackers. TJ started this as a side project and realized that he didn't have time :) Jim picked up some editing and project structuring.  It's open to everyone, so go nuts, download it, build it, fork it, extend it and share it. If you come up with something you wish to contribute back, send a pull request.

## Authors

 - TJ Holowaychuk ([visionmedia](http://github.com/visionmedia))

 - Jim Schubert ([jimschubert](http://github.com/jimschubert))

## Formats

 Mastering node is written using the markdown files provided in `./chapters`, which can then be converted to several output formats, currently including _pdf_, _mobi_, _epub_ and of course _html_.

## All Formats

    $ make

## PDF

Required by `make book.pdf`:

    $ brew install htmldoc

    $ make book.pdf

## HTML

Required by `make book.html`:

Node.js is required to convert markdown to html.  The conversion process was borrowed from node.js and its generation of API documentation.

The scripts are located in tools/docbook with minor modifications from the node.js repository.

    $ make book.html

## EPUB

Required by `make book.epub`:

Requires [Calibre](http://calibre-ebook.com/)

    $ make book.epub

## MOBI

Required by `make book.mobi`:

Requires [Calibre](http://calibre-ebook.com/), specifically `ebook-convert` version 3.

To install the most recent version of calibre:

    sudo python -c "import urllib2; exec urllib2.urlopen('http://status.calibre-ebook.com/linux_installer').read(); main()"

To make the `book.mobi` format:

    $ make book.mobi

## References

Contents of this eBook currently reference the following software versions:

  - node 0.4.0

## Source

All example source can be run simply by executing node against the file,

for example:

      $ node src/events/basic.js

## Hacking node

Executing node without parameters will enter a node console, a Read-Eval-Print-Loop (REPL). Here, you can inspect objects and execute commands.

	> require

	{ [Function: require]

	  resolve: [Function],

	  paths: 

	   [ '/home/jim/.node_modules',

	     '/home/jim/.node_libraries',

	     '/usr/local/lib/node' ],

	  main: undefined,

	  extensions: { '.js': [Function], '.node': [Function] },

	  registerExtension: [Function],

	  cache: {} }

	> console

	{ log: [Function],

	  info: [Function],

	  warn: [Function],

	  error: [Function],

	  dir: [Function],

	  time: [Function],

	  timeEnd: [Function],

	  trace: [Function],

	  assert: [Function] }

	> 

## License

Node.js is an official trademark of Joyent. This work is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.


Mastering Node by TJ Holowaychuk is licensed under a 
 Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.