Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Community powered rocket fuel for node.js
JavaScript HTML CSS Ruby
Branch: polotek
Pull request Compare This branch is 2 commits ahead, 293 commits behind master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
articles
bin
lib
outlines
public
tags
README.md
package.json

README.md

To run the demo:

node bin/server.js

Go to localhost:8080/index.htm

To add an article:

  • make a directory in topics for your article: mkdir topics/how-to-make-an-article (use only letters and dashes)
  • next write your article: vim topics/how-to-make-an-article/article.md
  • if you have any reference javascript implentation, just place them next to the article.md
  • create a metadata with this data: vim topics/how-to-make-an-article/metadata.json
{
  "title":"What is npm?",
  "date": "Today",
  "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": "Today",
  "tags": ["npm", "modules"],
  "author": "nico",
  "difficulty": 1
}
Something went wrong with that request. Please try again.