StrapDown.js is an awesome on-the-fly Markdown to HTML text processor.
StrapDown.js is already pretty advanced, as you can see by yourself with this very page (powered by StrapDown.js of course).
But there is also have a few things you need to know before using it:
Concretely, Bitbucket is always up, secured and quick (oooh, and Bitbucket is also awesome, completely free, and awesome too). Yeah, Bitbucket is 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.
The script is also hosted on GitHub and so 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.
Just follow this short tutorial :
Create an empty file, save it to mytext.html (yes, '.html' as HTML, but you will write in Markdown in no time), and then copy and paste the following 5 lines :
```markdown
This document is empty right now. Fill it out with awesome content !
```
There we show how to use some basic markup.
```markdown
You can now write your web page in Markdown.
You opened a textarea
tag, but a xmp
tag works as well.
And, yes, it is as simple as one HTML line at the beginning and one HTML line at the end of this document. ```
There we embed two images, and describe a little more how cool is StrapDown.js ! We also use another theme (united).
```markdown
You can now write your web page in Markdown.
You opened a textarea
tag, but a xmp
tag works as well.
And, yes, it is as simple as one HTML line at the beginning and one HTML line at the end of this document.
Feel free to use it, redistribute it etc, under the condition of the GPLv3 License.
StrapDown.js is awesome to quickly build nice-looking web pages, but it might not be efficient for anything more complicated, as it is really not designed for it.
With Markdown syntax, it's easy : .
Alright, here comes the mighty Cthulhu
For instance, you can add use Google Analytics to monitor the page's activity, with including a piece of Javascript code, before or after closing the textarea tag.
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create','UA-38514290-14','lbesson.bitbucket.io'); ga('send','pageview');
The previous paragraph was supposed to include Google Analytics web monitoring tool,
but hey, you are browsing without JavaScript enabled, what can I do for it ?
Maybe you are using a text-only browser (w3m, links, elinks ? I love elinks !),
or a 19th-century IE, or maybe you disabled JavaScript globally (which is kinda stupid) or site-by-site (with NoScript, as I do, which is brilliant, and safer).
This was a brief overview, to show the basic use of StrapDown.js. ```
StrapDown.js comes with an easy and excellent support of the incredible MathJax, as shown in these three examples: example n°3 and example n°4, and the last one which shows a new and quicker way to include MathJax (from StrapDown v0.5).
This example n°6 shows several examples of tables, written in Markdown and rendered as pretty (HTML+CSS !) tables in your browser. (new!)
There is now 18 different themes, coming from http://bootswatch.com/united and from the original project (strapdownjs.com) :
I recently added some new themes, and now there is these 9 new themes.
git clone https://github.com/Naereen/StrapDown.js
You can also easily download this up-to-date version of the md subdir of my lbesson.bitbucket.io repository: StrapDown.js.zip (and its PGP signature).
Rather than use the built-in "Print to a PDF" function of your browser, you should consider using StrapDown2PDF. It has a perfect support for Markdown markup.
Warning: but the LaTeX / MathJax support is still limited.
You might also be interested by a way to make a StrapDown.js-powered document autonomous, ie. not using the script anymore. For this purpose, I also wrote strapdown2html.py a Python program designed to do this (called, no surprise, strapdown2html.py).
Improve the SSL certificate? As that screenshot shows, SSL is available, but the certificate is not valid (it has been signed only for bitbucket.org and www.bitbucket.org):
Maybe host it on a CDN?
More "quick access" buttons on the top-navbar? (there is already a button to use Squirt (as shown in the example below), one to activate MathJax, and one to test a Google Analytics Beacon image.)
… and any new idea is most surely welcome!
nonavbarfixed=y
and keepicon=y
, and add more themes, which I did, of course.If you are using (or have used) my StrapDown.js, you can send an email, or contact me if you want, I would love to hear any feedback from you!
© 2013-2016
This project is released under the GPLv3 license, for more details, take a look at the LICENSE file in the source.
Basically, that allow you to use all or part of the project for you own business.