README.md

   1 wheic
   2 =====
   3
   4 This project is to build a HTML5 parser, then use that to build a WYSIWYG html
   5 editor for the browser.
   6
   7 The code is written in CoffeeScript for modern browsers. The HTML5 parser can
   8 also run under node.js.
   9
  10
  11 Status
  12 ------
  13
  14 HTML5 parser: all (1581) tests pass. Works in the browser and node.js
  15
  16 WYSIWYG editor: planning stages
  17
  18
  19 Quick Start Guide
  20 -----------------
  21
  22 1.      Open ``test.html`` in your browser.
  23
  24 2.      Open the console (right-click, inspect this element, console)
  25
  26 3.      After a few seconds, you should see "Tests passed: 1581, Failed: 0" in the
  27         console.
  28
  29 4.      Try running the parser in the console, example:
  30
  31                 window.wheic.parse_html("<p>foo</p>", {fragment: "body"})
  32
  33 For further reading, see "Running Under node.js" below.
  34
  35
  36 Running Under node.js
  37 ---------------------
  38
  39 Dependancies: node.js, coffeescript
  40
  41 1.      Install node.js https://nodejs.org/en/
  42
  43 2.      Install coffeescript. Try:
  44
  45                 apt-get install coffeescript
  46         or
  47
  48                 npm install -g coffee-script
  49
  50 3.      You can run the tests directly from coffeescript:
  51
  52                 coffee test.coffee
  53
  54 4.      Compile to javascript:
  55
  56                 make
  57
  58 5.      Run tests via compiled code:
  59
  60                 nodejs test.js
  61
  62 5.      Try using the parser in your own code:
  63
  64                 var wheic = require('./parse-html.js');
  65                 var dom = wheic.parse_html("<p>hi</p>", {fragment: 'body'});
  66                 ...
  67
  68
  69 Feedback, Questions, Etc
  70 ------------------------
  71
  72 Please communicate directly with Jason Woofenden by email: jason@jasonwoof.com
  73 or on freenode /msg JasonWoof