StrapDown.js is an awesome web script to write nice-looking webpages in pure Markdown, with no server side compilation.
StrapDown.js is already pretty advanced:
- Directly write your documents in Markdown, and let the browser do the boring compilation steps,
- no need for CSS, theming or painful styling: StrapDown.js is already friggin' beautiful, and responsive,
- quick and secure, thanks to GitHub and their great SSL support. Note : You can also use https://cdn.jsdelivr.net/gh/Naereen/StrapDown.js@master/strapdown.min.js to load the script from a quick and secure (HTTPS-aware) CDN.
- comes with many examples: first, second, third, 4th, 5th, 6th, 7th, 8th, 9th, 10th...
- 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),
- no external dependencies other than itself (and MathJax if you want to include it),
- no spying, no logging, no external leaking of your pages (and Google Analytics with a 1px beacon image can be included with an option,
- an excellent support of MathJax, as shown in this example or that one,
- quite lightweight:
,
- and, the last but not the least, an experimental embedding of the awesome SquirtFR bookmarklet to read as quickly as Lucky Luke.
- Note : You can also use https://cdn.jsdelivr.net/gh/Naereen/StrapDown.js@master/strapdown.min.js to have a true HTTPS support, by loading the script from a quick and secure (HTTPS-aware) CDN.
But there is also have a few things you need to know before using it:
- 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),
- a reduced support for browsers without javascript or with javascript disabled (the pages are still readable, but really ugly),
- hosted on GitHub and served by JsDelivr, which are wonderful but might not be always available.
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.JsDelivr.com: https://cdn.jsdelivr.net/gh/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.
This page explains how to use StrapDown.js:
There is also many different themes:
StrapDown.js supports MathJax, and it's really easy to use!
StrapDown.js also supports MarkDown tables:
And as any web-based document, a StrapDown.js powered HTML page can include any Javascript script, like this example which shows a research bar for a table:
More details on //lbesson.bitbucket.io/md/index.html, with examples and extra explanations.
Hacked by Lilian Besson (Naereen).
- JavaScript,
- HTML 5 and CSS 3.
MIT Licensed (file LICENSE). © Lilian Besson, 2015-16.
