Lerking/StrapDown.js
1
0
Fork 0
Code Issues 2 Pull Requests 1 Packages Projects Releases 2 Wiki Activity

Update index.html to be specific to GitHub, and update http://naereen.github.io/StrapDown.js/

Browse Source
This commit is contained in:
Lilian Besson
2015-12-29 21:54:24 +01:00
parent 95827bc183
commit 80dc7df10b
3 changed files with 34 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
index.htm
View File

@@ -1,4 +1,4 @@
<!DOCTYPE html><html><head><meta charset="utf-8"/><title>StrapDown.js on lbesson.bitbucket.org/md</title></head>
<!DOCTYPE html><html><head><meta charset="utf-8"/><title>StrapDown.js on GitHub/Naereen/</title></head>
<body>
<h1>StrapDown.js</h1>
<p><strong>StrapDown.js</strong> is an awesome <strong>on-the-fly</strong> <a href="https://en.wikipedia.org/wiki/Markdown">Markdown</a>
@@ -8,23 +8,25 @@ to <a href="https://en.wikipedia.org/wiki/HTML">HTML</a> <a href="https://en.wik
<ol>
<li><em>Directly write your documents in Markdown</em>, and let the browser do the boring <em>compilation</em> steps,</li>
<li>no need for CSS, theming or painful styling: <em>StrapDown.js</em> is already <em>friggin' beautiful</em>, and <em>responsive</em>,</li>
<li><em>quick</em> and <em>secure</em>, thanks to <em>bitbucket</em> and its SSL support (even if the certificate is not valid for <a href="https://lbesson.bitbucket.org">https://lbesson.bitbucket.org</a>, it is still secure),</li>
<li><em>quick</em> and <em>secure</em>, thanks to <em>GitHub</em> and their great SSL support. Note : You can also use <a href="https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js">https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js</a> to load the script from a quick and secure (HTTPS-aware) CDN.</li>
<li>comes with many examples: <a href="example1.html" title="Example 1">first</a>, <a href="example2.html" title="Example 2">second</a>, <a href="example3.html" title="Example 3">third</a>, <a href="example4.html" title="Example 4">4th</a>, <a href="example5.html" title="Example 5">5th</a>, <a href="example6.html" title="Example 6">6th</a>, <a href="example7.html" title="Example 7">7th</a>..</li>
<li>an almost perfect support for <em>text-only</em> browsers (as w3m, links, or elinks): <em>pure Markdown</em> is simpler to read than complicated HTML full of javascript, images (or worse),</li>
<li>no external dependencies other than itself (and <a href="http://www.mathjax.org/">MathJax</a> if you want to include it),</li>
<li>no spying, no logging, no external leaking of your pages (and <a href="http://perso.crans.org/besson/beacon.html">Google Analytics with a 1px beacon image</a> can be included with an option, and unfortunately <a href="https://confluence.atlassian.com/display/BITBUCKET/Publishing+a+Website+on+Bitbucket#PublishingaWebsiteonBitbucket-TechnicalFeaturesandLimitationsofthisFeature">rum.js from bitbucket hosting server</a>),</li>
<li>no spying, no logging, no external leaking of your pages (and <a href="http://perso.crans.org/besson/beacon.html">Google Analytics with a 1px beacon image</a> can be included with an option,</li>
<li>an excellent support of <a href="http://www.mathjax.org/"><em>MathJax</em></a>, as shown in <a href="example3.html">this example</a> or <a href="example5.html">that one</a>,</li>
<li>and, the last but not the least, an <em>experimental</em> embedding of the awesome <a href="http://lbesson.bitbucket.org/squirt">SquirtFR</a> bookmarklet to read <em>as quickly as Lucky Luke</em>.</li>
</ol>
<h2>Defaults ?</h2>
<h2>Drawbacks?</h2>
<p>But there is also have a few things you need to know before using it:</p>
<ol>
<li>It might get slow for <em>very long</em> pages (3000 lines can be already too much, <a href="3000.html">you can test by yourself with this long document</a>),</li>
<li>a reduced support for browsers <em>without javascript</em> or <em>with javascript disabled</em> (the pages are still readable, but really ugly),</li>
<li>hosted on bitbucket, which is wonderful but <em>might</em> not be always available (~ 3 hours of maintenance every 6 months, as shown with a small screenshot below).</li>
<li>It might get slow for <em>very long</em> pages, even if a <strong>3000-line</strong> document is handled very well and quickl (<a href="3000.html">you can test by yourself with this long document</a>),</li>
<li>a reduced support for browsers <em>without javascript</em> or <em>with javascript disabled</em> (the pages are still readable, but really <em>ugly</em>),</li>
<li>hosted on <a href="https://github.com/">GitHub</a> and served by <a href="https://rawgit.com">rawgit</a>, which are wonderful but <em>might</em> not be always available.</li>
</ol>
<h2>Concretly</h2>
<p>Concretly, bitbucket is always <em>up</em>, <em>secured</em> and <em>quick</em> (oooh, and bitbucket is also awesome, completely free, and awesome too). Yeah, <em>bitbucket is so awesome</em> that I had to say it <em>twice</em>, you read it correctly!</p>
<p>Concretly, GitHub is <a href="http://status.github.com/">always</a> <em>up</em>, <em>secured</em> and <em>quick</em> (oooh, and it is also awesome, completely free, and awesome too). Yeah, <em>is it so awesome</em> that I had to say it <em>twice</em>, you read it correctly!</p>
<p>But if you prefer, feel free to download the project (with <a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/downloads/StrapDown.js.zip">StrapDown.js.zip</a>) and upload it somewhere on your own server, or locally on your machine.</p>
<p>As the script is hosted on <a href="https://github.com/Naereen/StrapDown.js/">GitHub</a>, it can be loaded <em>quickly</em> and <em>securely</em> from <a href="https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js">cdn.rawgit.com</a>!</p>
<blockquote>
<h3>A quick "thank you" to the <a href="https://github.com/arturadib/strapdown/">initial project</a></h3>
<p>My version of StrapDown.js is a fork of <a href="http://strapdownjs.com">strapdownjs.com</a>, a cool project that <a href="https://github.com/arturadib/strapdown/graphs/contributors">kinda seems dead by now</a>.</p>
@@ -50,6 +52,8 @@ and then copy and paste the following 5 lines :</p>
<p>You opened a <code>textarea</code> tag, but a <code>xmp</code> tag works as well.</p>
<p>And, yes, it is <strong>as simple</strong> as <strong>one</strong> HTML line at the beginning and <strong>one</strong> HTML line at the end of this document.
```</p>
<hr />
<hr />
<h3>3) <a href="example2.html">A second example</a> <em>(you can click this to see it)</em></h3>
<p>There we embed two images, and describe a little more how cool is StrapDown.js !
We also use another theme (<em>united</em>).</p>
@@ -84,21 +88,24 @@ with including a piece of Javascript code, before <em>or</em> after closing the
<h2>That's it</h2>
<p>This was a brief overview, to show the basic use of <a href="index.html">StrapDown.js</a>.
```</p>
<h3>4) Last examples, with <a href="http://www.mathjax.org/">MathJax</a> enabled</h3>
<h3>4) More examples, with <a href="http://www.mathjax.org/">MathJax</a> enabled</h3>
<p>StrapDown.js comes with an <em>easy</em> and <em>excellent</em> support of the incredible <a href="http://www.mathjax.org/">MathJax</a>,
as shown in these three examples: <a href="example3.html">example n°3</a> and <a href="example4.html">example n°4</a>, and <a href="example5.html">the last one</a> which shows a new and quicker way to include <a href="http://www.mathjax.org/">MathJax</a> (from StrapDown <em>v0.5</em>).</p>
<h3>5) An example about tables</h3>
<p><a href="example6.html">This example n°6</a> shows several examples of tables, written in Markdown and rendered as pretty (HTML+CSS !) tables in your browser. (<em>new!</em>)</p>
<hr />
<hr />
<h1>Themes</h1>
<p>There is now 6 different themes, coming from <a href="http://bootswatch.com/">http://bootswatch.com/united</a> and from the original project (<a href="http://strapdownjs.com" title="Original project's website">strapdownjs.com</a>) :</p>
<ul>
<li>cyborg, as used by <em>the page</em> <a href="http://lbesson.bitbucket.org/md/index.html">you are currently reading</a> (and a <a href="http://bootswatch.com/cyborg">demo on bootswatch.com/cyborg</a>),</li>
<li>and united (as used <a href="example2.html">here</a>!), inspired from <a href="https://www.ubuntu.com/">ubuntu</a> (and a <a href="http://bootswatch.com/united">demo on bootswatch.com/united</a>).</li>
<li>cyborg, as used by the <a href="example1.html">first two examples</a> (and a <a href="http://bootswatch.com/cyborg">demo on bootswatch.com/cyborg</a>),</li>
<li>and united (as used <a href="http://lbesson.bitbucket.org/md/index.html">one this very page that you are reading</a>!), inspired from <a href="https://www.ubuntu.com/">ubuntu</a> (and a <a href="http://bootswatch.com/united">demo on bootswatch.com/united</a>).</li>
</ul>
<p>I recently added some new themes, and now there is <a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/themes/">these 4 new themes</a>:</p>
<ul>
<li><a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/themes/darkly.css">darkly</a> (and a <a href="http://bootswatch.com/darkly">demo on bootswatch.com/darkly</a>),</li>
<li><a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/themes/lumen.css">lumen</a> (and a <a href="http://bootswatch.com/lumen">demo on bootswatch.com/lumen</a>),</li>
<li><a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/themes/paper.css">paper</a> (and a <a href="http://bootswatch.com/paper">demo on bootswatch.com/paper</a>),</li>
<li><a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/themes/paper.css">paper</a> (and a <a href="http://bootswatch.com/paper">demo on bootswatch.com/paper</a>) as used by <a href="example4.html">example #4</a>,</li>
<li><a href="https://bitbucket.org/lbesson/lbesson.bitbucket.org/src/master/md/themes/simplex.css">simplex</a> (and a <a href="http://bootswatch.com/simplex">demo on bootswatch.com/simplex</a>).</li>
</ul>
<hr />
@@ -116,11 +123,14 @@ It has a perfect support for Markdown markup.</p>
<p><strong>Warning:</strong> but the <a href="https://en.wikipedia.org/wiki/LaTeX">LaTeX</a> / <a href="http://www.mathjax.org/">MathJax</a> support is still limited.</p>
<h3>Some examples of a good PDF printed version of a StrapDown.js powered page</h3>
<ul>
<li><a href="http://perso.crans.org/besson/publis/10_10_2014__Liberation.en.html">This (English) translation of a French press article</a> about <a href="http://www.mahindraecolecentrale.edu.in/discover.html">Mahindra École Centrale</a>, nicely printed to <a href="http://perso.crans.org/besson/publis/10_10_2014__Liberation.en.pdf">this PDF</a>,</li>
<li><a href="http://perso.crans.org/besson/publis/10_10_2014__Liberation.en.html">This (English) translation of a French press article</a> about <a href="http://www.mahindraecolecentrale.edu.in/">Mahindra École Centrale</a>, nicely printed to <a href="http://perso.crans.org/besson/publis/10_10_2014__Liberation.en.pdf">this PDF</a>,</li>
<li><a href="http://perso.crans.org/besson/publis/29_10_2014__LeMonde.en.html">This (English) translation of another French press article</a> about the future <a href="http://www.centrale-casablanca.ma/site/home.html">École Centrale Casablanca</a>, nicely printed to <a href="http://perso.crans.org/besson/publis/29_10_2014__LeMonde.en.pdf">a PDF, quickly modified by hand to include an image</a>,</li>
<li><a href="http://perso.crans.org/besson/publis/PDE_09_2014/index.html">This small (French) research report</a> on a <a href="https://en.wikipedia.org/wiki/Partial_differential_equations">non-linear Partial Differential Equation</a>, nicely printed to <a href="http://perso.crans.org/besson/publis/PDE_09_2014/index.pdf">a PDF, with very good support of LaTeX</a> (<a href="https://bitbucket.org/lbesson/bin/diff/strapdown2pdf?diff2=20fd4babc524&amp;at=master">since this modification</a>),</li>
<li><a href="http://perso.crans.org/besson/agreg/m/2/">This (French) homepage of a programming project</a> on <a href="https://en.wikipedia.org/wiki/Eulerian_path#Properties">Euler theorems on Eulerian path</a>. I did this as an assignement for <a href="http://perso.crans.org/besson/cv.en.pdf">my M.Sc. of Computer Science in 2014</a>, and it was also a good training for one oral exam of the <a href="https://en.wikipedia.org/wiki/Agr%C3%A9gation">French national competitive examination to become a prep' school professor</a> in Mathematics and Computer Science (for <a href="http://web.archive.org/web/20140709144720/agreg.org/ResultatsMerite2014.html">which I have been ranked 23rd among 795</a> in 2014!).</li>
</ul>
<blockquote>
<p>You might also be interested by a way to make a StrapDown.js-powered document autonomous, ie. not using the script anymore. <a href="https://bitbucket.org/lbesson/bin/history-node/master/strapdown2html.py">I am working</a> on a Python program <a href="https://bitbucket.org/lbesson/bin/str/master/strapdown2html.py">designed to do this (called, no surprise, strapdown2html.py)</a>. <strong>Warning:</strong> <em>Still being developped!</em></p>
</blockquote>
<hr />
<h1>Future features or ideas?</h1>
<ul>
@@ -142,6 +152,7 @@ It has a perfect support for Markdown markup.</p>
<ul>
<li><a href="https://github.com/arturadib/strapdown/issues/36">This question asked on Github on the 1st of May of 2014</a> by <a href="https://github.com/hardly">hardly</a> about the <a href="https://github.com/arturadib/strapdown">old strapdown repository</a>. To answer that question: the main difference is than I am still interested and eager to work on <a href="http://lbesson.bitbucket.org/md/">my StrapDown.js</a>, but it seems to not be the case of <a href="https://github.com/arturadib/">the previous developper</a>.</li>
<li><a href="http://quantego.com/">These guys at Quantego</a> are using my StrapDown.js for <a href="https://slides.quantego.com/">that small and interesting page</a>.</li>
<li>I got an email (<em>January 2015</em>) from one felow working for <a href="http://www.nexirius.com/">www.nexirius.com</a>, and so I created the demos on tables to answer him: <a href="example6.html">example #6</a> and <a href="example7.html">example #7</a>.</li>
</ul>
<blockquote>
<p>If you are using (or have used) my StrapDown.js, you can send an email, or <a href="http://perso.crans.org/besson/callme.en.html">contact me if you want</a>, I would love to hear any feedback from you!</p>

20
index.html
View File

@@ -1,4 +1,4 @@
<!DOCTYPE html><html><head><meta charset="utf-8"/><title>StrapDown.js on lbesson.bitbucket.org/md</title></head><body><xmp>
<!DOCTYPE html><html><head><meta charset="utf-8"/><title>StrapDown.js on GitHub/Naereen/</title></head><body><xmp>
# StrapDown.js
**StrapDown.js** is an awesome **on-the-fly** [Markdown](https://en.wikipedia.org/wiki/Markdown)
to [HTML](https://en.wikipedia.org/wiki/HTML) [text processor](https://en.wikipedia.org/wiki/Compiler).
@@ -8,11 +8,11 @@ to [HTML](https://en.wikipedia.org/wiki/HTML) [text processor](https://en.wikipe
1. *Directly write your documents in Markdown*, and let the browser do the boring *compilation* steps,
2. no need for CSS, theming or painful styling: *StrapDown.js* is already *friggin' beautiful*, and *responsive*,
3. *quick* and *secure*, thanks to *bitbucket* and its SSL support (even if the certificate is not valid for [https://lbesson.bitbucket.org](https://lbesson.bitbucket.org), it is still secure),
3. *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](https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js) to load the script from a quick and secure (HTTPS-aware) CDN.
4. comes with many examples: <a href="example1.html" title="Example 1">first</a>, <a href="example2.html" title="Example 2">second</a>, <a href="example3.html" title="Example 3">third</a>, <a href="example4.html" title="Example 4">4th</a>, <a href="example5.html" title="Example 5">5th</a>, <a href="example6.html" title="Example 6">6th</a>, <a href="example7.html" title="Example 7">7th</a>..
5. 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),
6. no external dependencies other than itself (and [MathJax](http://www.mathjax.org/) if you want to include it),
7. no spying, no logging, no external leaking of your pages (and [Google Analytics with a 1px beacon image](http://perso.crans.org/besson/beacon.html) can be included with an option, and unfortunately [rum.js from bitbucket hosting server](https://confluence.atlassian.com/display/BITBUCKET/Publishing+a+Website+on+Bitbucket#PublishingaWebsiteonBitbucket-TechnicalFeaturesandLimitationsofthisFeature)),
7. no spying, no logging, no external leaking of your pages (and [Google Analytics with a 1px beacon image](http://perso.crans.org/besson/beacon.html) can be included with an option,
8. an excellent support of [*MathJax*](http://www.mathjax.org/), as shown in [this example](example3.html) or [that one](example5.html),
9. and, the last but not the least, an *experimental* embedding of the awesome [SquirtFR](http://lbesson.bitbucket.org/squirt) bookmarklet to read *as quickly as Lucky Luke*.
@@ -22,15 +22,15 @@ 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](3000.html)),
2. a reduced support for browsers *without javascript* or *with javascript disabled* (the pages are still readable, but really *ugly*),
3. hosted on [BitBucket](https://bitbucket.org/), which is wonderful but *might* not be always available (~ [3 hours of maintenance every 6 months](http://status.bitbucket.org/history), as shown with a small screenshot below).
<a href="http://status.bitbucket.org/history"><img style="align:center;margin-right:auto;margin-left:auto;display:block;" src="bitbucket_maintenance.png" alt="Maintenance on bitbucket.org" title="Bitbucket.org annoucing a short maintenance" width="70%" /></a>
3. hosted on [GitHub](https://github.com/) and served by [rawgit](https://rawgit.com), which are wonderful but *might* not be always available.
## Concretly
Concretly, bitbucket is [always](http://status.bitbucket.org/) *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!
Concretly, GitHub is [always](http://status.github.com/) *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](https://bitbucket.org/lbesson/lbesson.bitbucket.org/downloads/StrapDown.js.zip)) and upload it somewhere on your own server, or locally on your machine.
As the script is hosted on [GitHub](https://github.com/Naereen/StrapDown.js/), 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](https://github.com/arturadib/strapdown/)
> My version of StrapDown.js is a fork of [strapdownjs.com](http://strapdownjs.com), a cool project that [kinda seems dead by now](https://github.com/arturadib/strapdown/graphs/contributors).
@@ -49,7 +49,7 @@ and then copy and paste the following 5 lines :
### Write here in Markdown rather than in HTML
> This document is empty right now. Fill it out with awesome content !
</textarea><script type="text/javascript" src="http://lbesson.bitbucket.org/md/strapdown.min.js"></script></body></html>
</textarea><script type="text/javascript" src="https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js"></script></body></html>
```
### 2) [A first example](example1.html) *(you can click this to see it)*
@@ -63,7 +63,7 @@ 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.
</textarea><script type="text/javascript" src="http://lbesson.bitbucket.org/md/strapdown.min.js"></script></body></html>
</textarea><script type="text/javascript" src="https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js"></script></body></html>
```
---
@@ -131,7 +131,7 @@ with including a piece of Javascript code, before *or* after closing the *textar
## That's it
This was a brief overview, to show the basic use of [StrapDown.js](index.html).
</textarea><script type="text/javascript" src="http://lbesson.bitbucket.org/md/strapdown.min.js"></script></body></html>
</textarea><script type="text/javascript" src="https://cdn.rawgit.com/Naereen/StrapDown.js/master/strapdown.min.js"></script></body></html>
```
### 4) More examples, with [MathJax](http://www.mathjax.org/) enabled

BIN
index.pdf
View File

Binary file not shown.