From 80dc7df10b4be6cd99ca56adf3395a10b1bdbd74 Mon Sep 17 00:00:00 2001 From: Lilian Besson Date: Tue, 29 Dec 2015 21:54:24 +0100 Subject: [PATCH] Update index.html to be specific to GitHub, and update http://naereen.github.io/StrapDown.js/ --- index.htm | 37 ++++++++++++++++++++++++------------- index.html | 20 ++++++++++---------- index.pdf | Bin 87278 -> 96179 bytes 3 files changed, 34 insertions(+), 23 deletions(-) diff --git a/index.htm b/index.htm index c33944f..6dd22f6 100644 --- a/index.htm +++ b/index.htm @@ -1,4 +1,4 @@ -StrapDown.js on lbesson.bitbucket.org/md +StrapDown.js on GitHub/Naereen/

StrapDown.js

StrapDown.js is an awesome on-the-fly Markdown @@ -8,23 +8,25 @@ to HTML https://lbesson.bitbucket.org, it is still secure), +

  • 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.
    • +
  • comes with many examples: first, second, third, 4th, 5th, 6th, 7th..
  • 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, and unfortunately rum.js from bitbucket hosting server),
    • +
  • 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,
  • and, the last but not the least, an experimental embedding of the awesome SquirtFR bookmarklet to read as quickly as Lucky Luke.
    • -

    Defaults ?

    +

    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 (3000 lines can be already too much, you can test by yourself with this long document),
      2. -
    2. a reduced support for browsers without javascript or with javascript disabled (the pages are still readable, but really ugly),
      3. -
    3. hosted on bitbucket, which is wonderful but might not be always available (~ 3 hours of maintenance every 6 months, as shown with a small screenshot below).
      4. +
    4. 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),
      5. +
    5. a reduced support for browsers without javascript or with javascript disabled (the pages are still readable, but really ugly),
      6. +
    6. hosted on GitHub and served by rawgit, which are wonderful but might not be always available.

    Concretly

    -

    Concretly, 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!

    +

    Concretly, 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!

    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.

    @@ -50,6 +52,8 @@ and then copy and paste the following 5 lines :

    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. ```

    +
    +

    3) A second example (you can click this to see it)

    There we embed two images, and describe a little more how cool is StrapDown.js ! We also use another theme (united).

    @@ -84,21 +88,24 @@ with including a piece of Javascript code, before or after closing the

    That's it

    This was a brief overview, to show the basic use of StrapDown.js. ```

    -

    4) Last examples, with MathJax enabled

    +

    4) More examples, with MathJax enabled

    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).

    +

    5) An example about tables

    +

    This example n°6 shows several examples of tables, written in Markdown and rendered as pretty (HTML+CSS !) tables in your browser. (new!)

    +

    Themes

    There is now 6 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 4 new themes:

    @@ -116,11 +123,14 @@ It has a perfect support for Markdown markup.

    Warning: but the LaTeX / MathJax support is still limited.

    Some examples of a good PDF printed version of a StrapDown.js powered page

    +
    +

    You might also be interested by a way to make a StrapDown.js-powered document autonomous, ie. not using the script anymore. I am working on a Python program designed to do this (called, no surprise, strapdown2html.py). Warning: Still being developped!

    +

    Future features or ideas?