Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A node.js / command line preview script for Github style Markdown

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Description

The purpose of this project is to make it easy to preview Github Flavor Markdown while offline using the same stylesheets and parsing that Github uses.

Requirements

  • A recent version of node.js (tested with 0.2.3)

Installation

No automated installation yet, simply run preview.js from this directory for now

Usage

Usage: node ./preview.js <markdown file> [-o <html out>] [--bottom]
    By default, HTML output gets printed to stdout
    To read stdin, use "-" as the markdown file
    When --bottom is used, Javascript will be generated to scroll to the bottom of the view when shown in a browser

Integration with Textmate

Create a new Command under a Bundle, and use this as the script:

node=/path/to/node
$node /path/to/preview.js $TM_FILEPATH --bottom
Something went wrong with that request. Please try again.