Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Branch: master
Fetching contributors…

Cannot retrieve contributors at this time

67 lines (45 sloc) 1.227 kB

docs

community powered rocket-fuel for node.js

http://docs.nodejitsu.com

Node Knockout Status, work in progress!

Usage

To generate the docs

node bin/generate

To start the docs server

node bin/server

Contributing articles

more documentation 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/article.md
  • create a metadata with this data: vim articles/how-to-make-an-article/metadata.json

metadata.json

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

Directory Structure

topics/
    article-name/ //url version
        metadata.json
        article.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",
  "difficulty": 1
}
Jump to Line
Something went wrong with that request. Please try again.