Get that restaurant github flavor at home in your editor.
Switch branches/tags
Nothing to show
Pull request Compare This branch is 35 commits behind alampros:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
.gitignore
README.md
docter.js
ghf_marked.css
package.json

README.md

#Docter

Get that restaurant github flavor at home in your editor.

Screenshot

Uses github's own redcarpet library to provide accurate markdown previews in your local editor. This screenshot shows Marked using docter as the markdown processor.

##GitHub Flavored Markdown Extensions Supported:

  • Fenced codeblocks

     process.stdin.on('data', function (chunk) {
     	gfm.stdin.write(chunk);
     	gfm.stdin.end();
     });
  • Strikethru support

  • Syntax highlighting via pygments

     require 'redcarpet'
     def markdown(text)
       options = [:fenced_code,:generate_toc,:hard_wrap,:no_intraemphasis,:strikethrough,:gh_blockcode,:autolink,:xhtml,:tables]
       html = Redcarpet.new(text, *options).to_html 
       syntax_highlighter(html)
     end
  • www.auto-linking.com

  • table support

    First Header Second Header
    Content Cell Content Cell
    Content Cell Content Cell

#Why NodeJS and not ruby?

I have future plans for this in a node project. And because it's my party.

#Requirements

Lots. Ungodly heaps of requirements.

#Usage

  1. Clone this repo locally
  2. cd to the repo
  3. [sudo] npm -g install

This will install the package into your global node_modules dir (usually /usr/local/lib/node_modules). It will also symbolically link two executables into your path:

  1. docter: the nodejs wrapper.
  2. gfm: the ruby redcarpet/pygments wrapper.

Both of these executables take markdown input through STDIN and output formatted HTML on STDOUT.

##Using with Marked.app

  1. In Marked's preferences, set the custom styles to the included ghf_marked.css
    Screenshot
  2. Set the markdown processor to the linked executable:
    Screenshot