Permalink
Browse files

added more details to README

  • Loading branch information...
1 parent 7d2ed6a commit e0c1f77ae8274a385a0c866ced8914d1875e4ba5 Aaron McCall committed Feb 17, 2012
Showing with 16 additions and 9 deletions.
  1. +16 −9 README.md
View
@@ -1,26 +1,33 @@
# jade.mode
-
-jade.mode is a jade syntax definition for SubEthaEdit & Coda.
-
-## Usage
+jade.mode is a jade syntax definition for SubEthaEdit & Coda. It is not complete, but it is useful. Please fork, make suggestions or otherwise help as you see fit.
### Installation
Simply check out this repo into either `~/Library/Application Support/Coda/Modes` or `~/Library/Application Support/SubEthaEdit/Modes`, be sure to name the directory `jade.mode`.
+## Features
+* Highlights all valid HTML5 tags
+* Supports embedded HTML
+* Highlights all text preceded by `-`, `=` or `!=` as the first non-whitespace character as though it were Javascript
+* Highlights save (#{foo}) and unsafe (!{bar}) interpolations
+* Highlights doctype declarations (!!! or doctype or <!DOCTYPE style)
+* Highlights single-line comments
+* Highlights jade-specific keywords (block, extends, etc.) when they are the first non-whitespace character.
+
## Known Issues
-* Multi-line comments are unsupported
-* Code that is not preceded by `-`, `=` or `!=` is not highlighted
+* Multi-line comments are unsupported due to limitations of the syntax definition language used by SubEthaEdit & Coda
+ (No capturing groups in regex)
+* Code that is not preceded by `-`, `=` or `!=` as the first non-whitespace character is not highlighted
* Code following a tag plus equal sign construct (eg, `p= foo || 'bar'`) is not highlighted
* Embedded JS blocks via script tag are currently not highlighted
+* Block expansion (eg, li.foo: a(href='bar')) is not supported only the first tag on the line is highlighted
## Author
Aaron McCall
-### Credits
-
-James Menera gave me invaluable feedback and encouragement. Thanks, James!
+## Credits
+James Menera gave me invaluable feedback and encouragement. Thanks, James!

0 comments on commit e0c1f77

Please sign in to comment.