Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 970 Bytes

README.md

File metadata and controls

31 lines (19 loc) · 970 Bytes

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:

Contributor guide

You will need Node.js (>0.6.x), Bower and Grunt 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)