Skip to content
This repository has been archived by the owner on Mar 22, 2020. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chemerisuk committed Apr 6, 2016
1 parent b8c3b24 commit 2f26eb3
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# better-emmet-plugin<br>[![NPM version][npm-version]][npm-url] [![NPM downloads][npm-downloads]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Bower version][bower-image]][bower-url]
> Emmet abbreviation parser for [better-dom](https://github.com/chemerisuk/better-dom)
Html strings are annoyingly verbose. Let's fix that with [Emmet](http://emmet.io/). Compare the HTML string:

```js
DOM.create("<ul><li class='list-item'></li><li class='list-item'></li><li class='list-item'></li></ul>");
```

to the equivalent micro template

```js
DOM.create(DOM.emmet("ul>li.list-item*3"));
```
Take a look at the [Emmet cheat sheet](http://docs.emmet.io/cheat-sheet/) for more examples, but be aware about the [differences](https://github.com/chemerisuk/better-dom/wiki/Abbreviation-parser-differences-from-the-emmet.io-project).

## Differences from emmet.io parser
1. Element aliases are not supported
2. Implied tag names are not supported
Expand All @@ -11,6 +24,11 @@
7. Default attributes are not supported
8. Short tags are not supported

## Do not be crazy with microtemplates!
Several recommendations from the [emmet docs](http://docs.emmet.io/):

> Abbreviations are not a template language, they don’t have to be “readable”, they have to be “quickly expandable and removable”.
## Browser support
#### Desktop
* Chrome
Expand Down

0 comments on commit 2f26eb3

Please sign in to comment.