Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Community powered rocket fuel for node.js

branch: refactor

This branch is 33 commits ahead and 58 commits behind master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 authors Isaac's id had an extraneous space in it. November 04, 2011
Octocat-spinner-32 bin
Octocat-spinner-32 pages
Octocat-spinner-32 theme
Octocat-spinner-32 vendor [api] Added code highlighting. August 26, 2011
Octocat-spinner-32 .gitignore [minor] Removed unnecessary public folder September 22, 2011
Octocat-spinner-32 .npmignore [dist] Added a blank .npmignore. September 19, 2011
Octocat-spinner-32 README.md
Octocat-spinner-32 config.json
Octocat-spinner-32 package.json
README.md

docs

http://docs.nodejitsu.com

community powered rocket-fuel for node.js

docs

We believe in sharing knowledge. So we have assembled this growing collection of node.js how-to articles. These articles range from basic to advanced. They provide relevant code samples and insights into the design and philosophy of node itself.

docs.nodejitsu.com is an open source project and is curated by the Nodejitsu team and friends. If you have articles or ideas that you would like to contribute, we'd very much like to accept your pull request!

Usage

Read Articles, get good at Node.js

Browse /articles/ folder or http://docs.nodejitsu.com

To generate the docs

blacksmith generate

To start the docs server

blacksmith preview

Contribution Guide

coming soon

To add an article:

  • make a directory in topics for your article: mkdir articles/how-to-make-an-article (use only letters and dashes)
  • next write your article: vim articles/how-to-make-an-article/content.md
  • create a metadata with this data: vim articles/how-to-make-an-article/page.json

metadata.json

{
  "title":"What is npm?",
  "date": "Fri Aug 26 2011 03:08:50 GMT-0700 (PST)",
  "tags": ["npm", "modules"],
  "author": "Nico Reed",
  "difficulty": 1
}

Directory Structure

topics/
    article-name/ //url version
        page.json
        content.md //file with the real article
        assets/
            ...
    ...

Metadata Format

{
  "title":"What is npm?",
  "date": "Fri Aug 26 2011 03:08:50 GMT-0700 (PST)",
  "tags": ["npm", "modules"],
  "author": "Nico Reed",
  "difficulty": 1
}
Something went wrong with that request. Please try again.