-

+ + + + + + + + Strapdown.js @ GitHub.com/Naereen + + + + + +
+
+ View on GitHub + +

Strapdown.js @ GitHub.com/Naereen

+

StrapDown.js is an awesome javascript tool to quickly publish nice-looking web-pages in pure Markdown, with no server side compilation.

+ +
+ Download this project as a .zip file + Download this project as a tar.gz file +
+
+
+ + +
+
+

StrapDown.js

StrapDown.js is an awesome web script to write nice-looking webpages in pure Markdown, with no server side compilation.

-

-More details

+

+More details

More details on http://lbesson.bitbucket.org/md/index.html, with examples, explanations and even more!

+

+Features

+ +

StrapDown.js is already pretty advanced, as you can see by yourself with this very page (powered by StrapDown.js of course).

+ +
    +
  1. +Directly write your documents in Markdown, and let the browser do the boring compilation steps,
  2. +
  3. no need for CSS, theming or painful styling: StrapDown.js is already friggin' beautiful, and responsive,
  4. +
  5. +quick and secure, thanks to GitHub and their great SSL support. Note : You can also use https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js to load the script from a quick and secure (HTTPS-aware) CDN.
  6. +
  7. comes with many examples: first, second, third, 4th, 5th, 6th, 7th...
  8. +
  9. an almost perfect support for text-only browsers (as w3m, links, or elinks): pure Markdown is simpler to read than complicated HTML full of javascript, images (or worse),
  10. +
  11. no external dependencies other than itself (and MathJax if you want to include it),
  12. +
  13. no spying, no logging, no external leaking of your pages (and Google Analytics with a 1px beacon image can be included with an option,
  14. +
  15. an excellent support of MathJax, as shown in this example or that one,
  16. +
  17. and, the last but not the least, an experimental embedding of the awesome SquirtFR bookmarklet to read as quickly as Lucky Luke.
  18. +
+ +

+Drawbacks?

+ +

But there is also have a few things you need to know before using it:

+ +
    +
  1. It might get slow for very long pages, even if a 3000-line document is handled very well and quickl (you can test by yourself with this long document),
  2. +
  3. a reduced support for browsers without javascript or with javascript disabled (the pages are still readable, but really ugly),
  4. +
  5. hosted on GitHub and served by rawgit, which are wonderful but might not be always available.
  6. +
+ +

+Concretely

+ +

Concretely, GitHub is always up, secured and quick (oooh, and it is also awesome, completely free, and awesome too). Yeah, is it so awesome that I had to say it twice, you read it correctly!

+ +

But if you prefer, feel free to download the project (with StrapDown.js.zip) and upload it somewhere on your own server, or locally on your machine.

+ +

As the script is hosted on GitHub, it can be loaded quickly and securely from cdn.rawgit.com: https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js!

+ +
+

+A quick "thank you" to the initial project +

+ +

My version of StrapDown.js is a fork of strapdownjs.com, a cool project that kinda seems dead by now.

+
+

@@ -97,16 +156,18 @@

This project is released under the MIT license, for more details, take a look at the LICENSE file in the source.

+

+
-