Skip to content
An assortment of essential Node.js dags, API references, and developer tutorials. D'ya like dags? What? Oh, **docs**. Sure, I like "dags."
JavaScript
Pull request Compare This branch is 129 commits behind mattpardee:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
build
resources
src
tests
.gitignore
.gitmodules
app.js
build.js
package.json
post-receive.sh
readme.md
server.js

readme.md

Introduction

This is both the source documentation and build system for the Node Manual. It consists of:

  • Source files for the Node.js Reference Guide, Node.js tutorials, and Node.js Javascript Reference Guide (located in src/)
  • A build system to generate this content (located at build.js)
  • Resources such as CSS, Javascript, and images, for the final output (located at resources/)

The build system relies on two repos as submodules (both located under (build/):

  • The doc-build system converts Markdown to HTML, and is used for the Node Manual documentation
  • C9's fork of ndoc, which takes Javascript source files and generates HTML documentation from the comments (also styled in Markdown)

Remember! After you clone this repo, call

git submodule init
git submodule update
npm install

Running a Build

To run the build, open your command prompt and type:

node build.js

This first launches doc-build, which reads nodejs_dev_guide/ and begins to assemble the subdirectory markdown files. These markdown files are modified, and placed into a tmp directory. From there, they are converted into HTML files, and placed into out/.

After that, ndoc runs across the Javascript files in src/js_doc and src/nodejs_ref_guide, and proceeds to convert them into HTML files also placed into the out/ directory.

By default, this system builds every version of documentation listed under src/nodejs_ref_guide. You could also pass in one more argument to specify the Node.js source version. This can be one of the following values:

  • The word "latest," which automatically builds the latest version.
  • A string like x.y.z, where x, y, and z are all numerals, to build a specific version. For example, to build the 0.6.7 branch, type:

    node build.js 0.6.7

Contributing

We'll very gladly take any pull requests for new documentation! This source material is intended to be open and sharable to all.

License Agreement

To protect the interests of our contributors and users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is the simplest of agreements, requiring that the contributions you make to are only those you're allowed to make. This helps us significantly reduce future legal risk for everyone involved. It is easy, helps everyone, takes ten minutes, and only needs to be completed once. There are two versions of the agreement:

  1. The Individual CLA: use this version if you're working on documentation in your spare time, or can clearly claim ownership of copyright in what you'll be submitting.
  2. The Corporate CLA: have your corporate lawyer review and submit this if your company is going to be contributing to the documentation

Please print the CLA and fill it out and sign it. Then, either send it by snail mail, fax us, or send it back scanned (or as a photo) by e-mail.

Email: info@ajax.org

Fax: +31 (0) 206388953

Address: Ajax.org B.V. Keizersgracht 241 1016 EA, Amsterdam the Netherlands

Copyright

Content providers include:

License

Creative Commons License
Node Manual is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

Something went wrong with that request. Please try again.