branch: elpa/jade-mode
commit 2f0f55cae463b89a8c455b2037fcacf0f69e5075
Author: Brian Carlson <[email protected]>
Commit: Brian Carlson <[email protected]>
updated readme
---
README.md | 51 +++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 41 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 23635039e2..4f2714bbf8 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
-# jade-mode
+# sws-mode
-Emacs major mode for [jade template](http://github.com/visionmedia/jade)
highlighting.
+## major mode for jade-mode and stylus-mode
-Still in very early stages. Some simple highlighting of tags, ids, and
classes works; however, it highlights incorrectly into the javascript code and
plain text code as well.
+__S__ignificant __W__hitespace __M__ode. Because Jade and Stylus are both
'significant white space' languages, sws-mode can be used to edit both types of
files
Lines can be indented or un-indented (is that a word?) with tab, shift-tab
respectively. Indentation will look at the proceeding line and not indent more
than 1 level of nesting below it.
@@ -11,23 +11,54 @@ Lines can be indented or un-indented (is that a word?) with
tab, shift-tab respe
#container
.content
^
- |----cursor anywhere on this line, press tab
+ |----cursor anywhere on this line except at beginning of text, press tab
or S-tab
+
+ html
+ body
+ #container
+ .content
+ ^
+ |---- cursor moves to beginning of text...once cursor is at beginning
of text, press tab
html
body
#container
.content
- ^
- |---- cursor anywhere on this line, press tab again
+ ^
+ |---- now line is maximum indented, press tab again
html
body
#container
.content
+ ^
+ |---- line moves to minimum indentation level (no indentation)
+
+Regions can be indentend in a similar way; however, this is still buggy...
+
+Since jade and stylus nesting is somewhat related to sexp layout I hope to
have sexp related selection & manipulation working in the future. Currently
working on `jade-highlight-sexp`
+
+
+### jade-mode
+
+Emacs major mode for [jade template](http://github.com/visionmedia/jade)
highlighting. This mode extends sws-mode to provide some rudimentary syntax
highlighting.
+
+Still in very early stages. Some simple highlighting of tags, ids, and
classes works; however, it highlights incorrectly into the javascript code and
plain text code as well.
+
+
+I would like to get the highlighting working better. Also note javascript
highlighting with either js2-mode or espresso-mode should be possible...I'm a
major major-mode writing noob so it'll take a while.
+
+### stylus-mode
+I'm not sure yet how to highlight .styl files, so for now, just use sws-mode
when editing stylus mode.
+
+## Installation instructions
-Regions can be indentend in a similar way; however, this is still buggy as
hell.
+Copy the jade-mode.el and sws-mode.el to some directory on your computer. I
put mine under `~/code/jade-mode` and sym-link the jade-mode folder into
`~/.emacs.d/vendor/`. You can just as easily put the folder itself under
'~/.emacs.d/vendor/`
-I would like to get the highlighting working better. Also note javascript
highlighting with either js2-mode or espresso-mode should be possible.
+Add the following lines to any of your initialization files
-Since jade nesting is somewhat related to sexp layout I hope to have sexp
related selection & manipulation working in the future. Currently working on
`jade-highlight-sexp`
-
+ (add-to-list 'load-path "~/.emacs.d/vendor/jade-mode")
+ (require 'sws-mode)
+ (require 'jade-mode)
+ (add-to-list 'auto-mode-alist '("\\.styl$" . sws-mode))
+ (add-to-list 'auto-mode-alist '("\\.jade$" . sws-mode))
