README.txt

   1 Peach HTML5 Editor
   2 ==================
   3
   4 Peach Editor is a WYSIWYG HTML5 editor for the browser.
   5
   6
   7 Vision
   8 ------
   9
  10 Most online HTML editors are built around the "contenteditable" feature of
  11 modern browsers. While this gives developers a lot of features right out of the
  12 box, they must surrender almost complete control over how it works, and thus
  13 we all get stuck using editors that are frustrating and have loads of bugs and
  14 compatibility issues.
  15
  16 Instead of trying to create an ever-expanding set of workarounds for the
  17 quirks, limitations and bugs of different platforms/browsers implementation of
  18 contenteditable, this project aims to create an HTML5 editor that does not use
  19 this feature at all.
  20
  21 This method is much more work, but has the potential to make an editor that is
  22 actually good, since all the code that makes it tick is part of the project,
  23 and its code can be modified.
  24
  25 Jason couldn't find an HTML parser in JavaScript that was at all accurate
  26 according to the HTML5 spec, so he wrote one; see ``parser.js``.
  27
  28 Current work is going into the GUI.
  29
  30
  31 Status
  32 ------
  33
  34 The HTML5 parser: complete  component passes the full test suite (1581 tests).
  35
  36 Editor GUI: in early development stages.
  37
  38
  39 Quick Start
  40 -----------
  41
  42 Open ``index.html`` in a browser (no need for a web server)
  43
  44 For further reading, see "Running Under node.js" below.
  45
  46
  47 Technologies
  48 ------------
  49
  50 Programming language: JavaScript
  51
  52 HTML5 Parser: Spec compliant, also runs on node.js
  53
  54 Interface: Implemented using the DOM api. No ``contenteditable`` or jquery.
  55
  56
  57 Running Parser with node.js
  58 ---------------------------
  59
  60 The parser can run without the browser, try:
  61
  62         nodejs parser_tests.js
  63
  64
  65 Feedback, Questions, Etc
  66 ------------------------
  67
  68 Please communicate directly with Jason Woofenden via his website:
  69 https://jasonwoof.com/contact