index.html (8075B)
1 <!DOCTYPE html><html><head><meta charset="utf-8"/><title>StrapDown.js on lbesson.bitbucket.org/md</title></head><body><xmp theme="cyborg"> 2 # StrapDown.js 3 **StrapDown.js** is an awesome **on-the-fly** [Markdown](https://en.wikipedia.org/wiki/Markdown) 4 to [HTML](https://en.wikipedia.org/wiki/HTML) [text processor](https://en.wikipedia.org/wiki/Compiler). 5 6 ## Features 7 - *Directly write your documents in Markdown*, and let the browser do the boring *compilation* steps, 8 - no need for CSS, theming or painless styling : *StrapDown.js* is already *friggin' beautiful*, and *responsive*, 9 - *quick* and *secure*, thanks to *bitbucket* and its SSL (even if the certificate is not valid for [lbesson.bitbucket.org](https://lbesson.bitbucket.org), it is still secure), 10 - an almost perfect support for text-only browsers : pure Markdown is simpler to read than complicated HTML full of javascript, 11 - no external dependencies other than itself, 12 - no spying, no logging, no leaking of your pages (only [Google Analytics](http://besson.qc.to/beacon.html) with the default template, and [rum.js from bitbucket hosting server](https://confluence.atlassian.com/display/BITBUCKET/Publishing+a+Website+on+Bitbucket#PublishingaWebsiteonBitbucket-TechnicalFeaturesandLimitationsofthisFeature)). 13 14 - And, the last but not the least, *experimental* embedding of the even awesomer [SquirtFR](https://lbesson.bitbucket.org/squirt) bookmarklet to read *as quickly as Lucky Luke*. 15 16 ## Defaults ? 17 - It might get slow for *long* pages (3000 lines seem to be too much), 18 - a reduced support for browsers *without javascript* or *with javascript disabled* (the pages are still readable, but really ugly), 19 - hosted on bitbucket, which is wonderful but might not be always available (~ 3 hours of maintenance every 6 months). 20 21 Concretly, bitbucket is always *up*, *secured* and *quick* (ooh, 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. 22 23 But if you prefer, feel free to download [StrapDown.js.zip](https://bitbucket.org/lbesson/lbesson.bitbucket.org/downloads/StrapDown.js.zip) and embed it on your own server. 24 25 > ## A quick "thank you" to the initial project 26 > My version of StrapDown.js is a fork of [strapdownjs.com](http://strapdownjs.com), a cool project that kinda seems dead by now. 27 28 ---- 29 30 ## How to start using StrapDown.js ? 31 **Just follow this short tutorial** : 32 33 ### [Default template to use](example0.html) *(you can click this to see it)* 34 Create an empty file, save it to *mytext.html* 35 (yes, *.html* as HTML, but you will write in Markdown in no time), 36 and then copy and paste the following 5 lines : 37 38 ```markdown 39 <!DOCTYPE html><html><head><title>A StrapDown.js template</title></head><body><textarea theme="cyborg"> 40 ### Write here in Markdown rather than in HTML 41 > This document is empty right now. Fill it out with awesome content ! 42 43 </textarea><script type="text/javascript" src="//lbesson.bitbucket.org/md/strapdown.js?src=example0"></script></body></html> 44 ``` 45 46 ### [A first example](example1.html) *(you can click this to see it)* 47 There we use some markup. 48 49 ```markdown 50 <!DOCTYPE html><html><head><meta charset="utf-8"/><title>« My first test with StrapDown.js »</title></head><body><textarea theme="cyborg"> 51 # This is a Markdown document 52 You can now write your web page in Markdown. 53 54 You opened a `textarea` tag, but a `xmp` tag works as well. 55 56 And, yes, it is **as simple** as **one** HTML line at the beginning and **one** HTML line at the end of this document. 57 </textarea><script type="text/javascript" src="//lbesson.bitbucket.org/md/strapdown.js?src=example1"></script></body></html> 58 ``` 59 60 ### [A second example](example2.html) *(you can click this to see it)* 61 There we embed two images, and describe a little more how cool is StrapDown.js ! 62 We also use another theme (*united*). 63 64 ```markdown 65 <!DOCTYPE html><html><head><title>Awesome second example with StrapDown.js</title></head><body><textarea theme="united"> 66 # This is a Markdown document 67 You can now write your web page in Markdown. 68 You opened a `textarea` tag, but a `xmp` tag works as well. 69 And, yes, it is **as simple** as **one** HTML line at the beginning and **one** HTML line at the end of this document. 70 71 ## What to say more 72 Feel free to use it, redistribute it etc, *under the condition of the GPLv3 License*. 73 74 ## Only for textual, simple documents 75 StrapDown.js is *awesome* to quickly build nice-looking web page, 76 but it might not be efficient for anything more complicated, as it is really not designed for it. 77 78 ## Add a picture ? 79 With Markdown syntax, it's easy : . 80 81 ### An other one ? 82 Alright, here comes the mighty Cthulhu  83 84 ### A last one, because it's dangerous to go alone : 85 86  87 88 ## Add anything you want, it *might* work 89 For instance, you can add use Google Analytics to monitor the page's activity, 90 with including a piece of Javascript code, before *or* after closing the *textarea* tag. 91 92 <script type="text/javascript"> 93 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ 94 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), 95 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) 96 })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); 97 ga('create','UA-38514290-14','lbesson.bitbucket.org'); ga('send','pageview'); 98 </script> 99 <noscript> 100 The previous parapraph was supposed to include Google Analytics web monitoring tool, 101 but hey, you are browsing without JavaScript enabled, what can I do for it ? <br/> 102 Maybe you are using a text-only browser (w3m, links, elinks ? I love elinks !), 103 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). 104 </noscript> 105 106 ## That's it 107 This was a brief overview, to show the basic use of [StrapDown.js](index.html). 108 </textarea><script type="text/javascript" src="//lbesson.bitbucket.org/md/strapdown.js?src=example2"></script></body></html> 109 ``` 110 111 ### Themes 112 Only two themes from [strapdownjs.com]() are pretty enough to be included : 113 114 - [cyborg](http://bootswatch.com/cyborg) for a demo, 115 - [united](http://bootswatch.com/united) for a demo. 116 117 More will soon be availables ! 118 119 ### Printing to a nice looking PDF 120 Rather than use the built-in "Print to a PDF" function 121 of your browser, you should consider using [StrapDown2PDF](strapdown2pdf.html). 122 123 ---- 124 125 # Cloning 126 As of now, StrapDown.js does **not** have it own git repository. 127 And I don't want to, because it is cleaner to let it live on http://lbesson.bitbucket.org/md. 128 129 But, there, you can download this not up-to-date version of the *md* subdir of my [lbesson.bitbucket.org](https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/) repository : 130 [StrapDown.js.zip](https://bitbucket.org/lbesson/lbesson.bitbucket.org/downloads/StrapDown.js.zip) 131 (and [its PGP signature](https://bitbucket.org/lbesson/lbesson.bitbucket.org/downloads/StrapDown.js.zip.asc).) 132 133 ---- 134 135 # Future features 136 - Maybe host it on a *CDN*, 137 - More themes, 138 - Hack something to force using local cached version of the script and stylesheets rather than download them every time ? 139 140 ---- 141 142 # About 143 ### Hacked by [Lilian Besson](https://bitbucket.org/lbesson) 144 145 ### Languages 146 - JavaScript; 147 - CSS 3. 148 149 ### License 150 This project is released under the **GPLv3 license**, for more details, 151 take a look at the [LICENSE](http://besson.qc.to/LICENSE.html) file in the source. 152 153 *Basically, that allow you to use all or part of the project for you own business.* 154 </xmp><script type="text/javascript" src="strapdown.js"></script><img alt="GA|Analytics" style="visibility: hidden; display: none;" src="https://ga-beacon.appspot.com/UA-38514290-14/md/index.html?pixel"/></body></html>