crgr / strapdown

Strapdown + Automatic table of contents

Home Page:http://yie.me/strapdown

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Strapdown.js

Strapdown.js makes it embarrassingly simple to create elegant Markdown documents. No server-side compilation required.

This is a fork of the awesome project at http://strapdownjs.com

This fork adds auto generated table of contents and can be used as a jQuery plugin.

For more, please see:

Sample

View Live

Contributor guide

You will need Node.js (>0.6.x) and Bower to generate the bundles. To bundle/compile the assets, issue in the project directory:

$ npm install
$ bower install
$ grunt

Other available commands are:

  • grunt watch - refreshes the output files on where are changed.
  • grunt test - only runs the tests

Bug fixes should go in the latest version - no need to bump it. New features or anything that changes the old behavior should go into a bumped version (update version in package.json)

About

Strapdown + Automatic table of contents

http://yie.me/strapdown

License:MIT License


Languages

Language:HTML 51.7%Language:JavaScript 39.6%Language:CSS 7.6%Language:PHP 1.2%