addons/document_page/static/src/lib/wiky/Readme.md

   1 Wiky.js - a javascript library to convert Wiki Markup language to HTML.
   2 =======================
   3
   4 (It is buggy, please use with care)
   5
   6 Wiky.js is a javascript library that converts Wiki Markup language to HTML.
   7
   8
   9 How to use it
  10 -------------------
  11 Include wiki.js into your HTML file. Wiky.js has only one function, which is wiky.process(wikitext).
  12
  13 Please see index.html for an example.
  14
  15 *wiky.js does not depend on jQuery, which is included for testing purpose.
  16
  17
  18
  19 Supported Syntax
  20 -------------------
  21 * == Heading ==
  22 * === Subheading ===
  23 * [http://www.url.com Name of URLs]
  24 * [[File:http://www.url.com/image.png Alternative Text]]
  25 * -------------------- (Horizontal line)
  26 * : (Indentation)
  27 * # Ordered bullet point
  28 * * Unordered bullet point
  29
  30
  31
  32 License
  33 ------------------
  34 Creative Commons 3.0
  35
  36
  37
  38 Contributors
  39 -------------------
  40 Tanin Na Nakorn
  41 Tanun Niyomjit (Designer)