From ea5445d8735c919739b251b1be57083430372b88 Mon Sep 17 00:00:00 2001 From: Jason Woofenden Date: Tue, 16 May 2017 15:07:29 -0400 Subject: [PATCH] fix link, tweak text --- README.md | 69 ----------------------------------------------------- README.txt | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++ index.html | 4 +++- parser_tests.html | 3 ++- 4 files changed, 74 insertions(+), 71 deletions(-) delete mode 100644 README.md create mode 100644 README.txt diff --git a/README.md b/README.md deleted file mode 100644 index 97d2628..0000000 --- a/README.md +++ /dev/null @@ -1,69 +0,0 @@ -Peach HTML5 Editor -================== - -Peach Editor is a WYSIWYG HTML5 editor for the browser. - - -Vision ------- - -Most online HTML editors are built around the "contenteditable" feature of -modern browsers. While this gives developers a lot of features right out of the -box, they must surrender almost complete control over how it works, and thus -we all get stuck using editors that are frustrating and have loads of bugs and -compatibility issues. - -Instead of trying to create an ever-expanding set of workarounds for the -quirks, limitations and bugs of different platforms/browsers implementation of -contenteditable, this project aims to create an HTML5 editor that does not use -this feature at all. - -This method is much more work, but has the potential to make an editor that is -actually good, since all the code that makes it tick is part of the project, -and its code can be modified. - -Jason couldn't find an HTML parser in JavaScript that was at all accurate -according to the HTML5 spec, so he wrote one; see ``parser.js``. - -Current work is going into the GUI. - - -Status ------- - -The HTML5 parser: complete component passes the full test suite (1581 tests). - -Editor GUI: in early development stages. - - -Quick Start ------------ - -Open ``index.html`` in a browser (no need for a web server) - -For further reading, see "Running Under node.js" below. - - -Technologies ------------- - -Programming language: JavaScript - -HTML5 Parser: Spec compliant, also runs on node.js - -Interface: Implemented using the DOM api. No ``contenteditable`` or jquery. - - -Running Parser with node.js ---------------------------- - -The parser can run without the browser, try: - - nodejs parser_tests.js - - -Feedback, Questions, Etc ------------------------- - -Please communicate directly with Jason Woofenden via his website: -https://jasonwoof.com/contact diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..97d2628 --- /dev/null +++ b/README.txt @@ -0,0 +1,69 @@ +Peach HTML5 Editor +================== + +Peach Editor is a WYSIWYG HTML5 editor for the browser. + + +Vision +------ + +Most online HTML editors are built around the "contenteditable" feature of +modern browsers. While this gives developers a lot of features right out of the +box, they must surrender almost complete control over how it works, and thus +we all get stuck using editors that are frustrating and have loads of bugs and +compatibility issues. + +Instead of trying to create an ever-expanding set of workarounds for the +quirks, limitations and bugs of different platforms/browsers implementation of +contenteditable, this project aims to create an HTML5 editor that does not use +this feature at all. + +This method is much more work, but has the potential to make an editor that is +actually good, since all the code that makes it tick is part of the project, +and its code can be modified. + +Jason couldn't find an HTML parser in JavaScript that was at all accurate +according to the HTML5 spec, so he wrote one; see ``parser.js``. + +Current work is going into the GUI. + + +Status +------ + +The HTML5 parser: complete component passes the full test suite (1581 tests). + +Editor GUI: in early development stages. + + +Quick Start +----------- + +Open ``index.html`` in a browser (no need for a web server) + +For further reading, see "Running Under node.js" below. + + +Technologies +------------ + +Programming language: JavaScript + +HTML5 Parser: Spec compliant, also runs on node.js + +Interface: Implemented using the DOM api. No ``contenteditable`` or jquery. + + +Running Parser with node.js +--------------------------- + +The parser can run without the browser, try: + + nodejs parser_tests.js + + +Feedback, Questions, Etc +------------------------ + +Please communicate directly with Jason Woofenden via his website: +https://jasonwoof.com/contact diff --git a/index.html b/index.html index 2afd5b9..d8e030c 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,9 @@

Peach HTML5 Editor

-

This directory contains the source code for the Peach HTML5 Editor. Instructions on working with the code are in README.txt

+

This directory contains the source code for the Peach HTML5 Editor.

+ +

Learn more

Run the demo

diff --git a/parser_tests.html b/parser_tests.html index 83772be..52bd87b 100644 --- a/parser_tests.html +++ b/parser_tests.html @@ -7,9 +7,10 @@

Peach HTML5 Parser test page

-

Check the inspector/console for test results.

+

Loading tests...

+

Tests running. Check console for test results.

Source - AGPLv3+

-- 1.7.10.4