An assortment of essential Node.js dags, API references, and developer tutorials. D'ya like dags? What? Oh, **docs**. Sure, I like "dags."
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 15 commits behind mattpardee:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
resources
src
tests
.gitignore
.gitmodules
additionalObjs.json
app.js
build.js
package.json
parseOptions.json
parser.js
post-receive.sh
readme.md
server.js

readme.md

Introduction

This is the source documentation for 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/)
  • Resources such as CSS, Javascript, and images, for the final output (located at resources/)
  • Templates for the design (also located at resources/)

For API documentation, we use Panino; for the reference material, we use Panda-Docs.

It's worth noting that there is a git commit hook running on the NodeManual server. Any pushes or merges into the master branch of this repo automatically rebuilds all versions of the documentation on the website.

Running a Build

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

node build.js [optional_version_number]

This launches a build of the latest documentation set, which is determind by whatever the last folder in src/ is. These converted HTML files are placed into out/. Also, a symlink called latest/ is created, that points to the latest output files. If you pass in optional_version_number, then only that doc set is built, and no symlink is created.

Contributing

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

Copyright

Major content providers include:

License

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