forked from VimPlug/emmet-vim
201 lines
4.6 KiB
Markdown
201 lines
4.6 KiB
Markdown
# Emmet-vim
|
|
|
|
|
|
[](https://travis-ci.org/mattn/emmet-vim)
|
|
|
|
[emmet-vim](https://mattn.github.io/emmet-vim/) is a vim plug-in
|
|
which provides support for expanding abbreviations similar to
|
|
[emmet](http://emmet.io/).
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
[Download zip file](http://www.vim.org/scripts/script.php?script_id=2981):
|
|
|
|
```sh
|
|
cd ~/.vim
|
|
unzip emmet-vim.zip
|
|
```
|
|
|
|
To install using [pathogen.vim](https://github.com/tpope/vim-pathogen):
|
|
|
|
```sh
|
|
git clone https://github.com/mattn/emmet-vim.git ~/.vim/bundle/emmet-vim
|
|
```
|
|
|
|
To install using [Vundle](https://github.com/gmarik/vundle):
|
|
|
|
```vim
|
|
" add this line to your .vimrc file
|
|
Plugin 'mattn/emmet-vim'
|
|
```
|
|
|
|
To install using [Vim-Plug](https://github.com/junegunn/vim-plug):
|
|
|
|
```vim
|
|
" add this line to your .vimrc file
|
|
Plug 'mattn/emmet-vim'
|
|
```
|
|
|
|
To checkout the source from repository:
|
|
|
|
```sh
|
|
cd ~/.vim/bundle
|
|
git clone https://github.com/mattn/emmet-vim.git
|
|
```
|
|
|
|
or:
|
|
|
|
```sh
|
|
git clone https://github.com/mattn/emmet-vim.git
|
|
cd emmet-vim
|
|
cp plugin/emmet.vim ~/.vim/plugin/
|
|
cp autoload/emmet.vim ~/.vim/autoload/
|
|
cp -a autoload/emmet ~/.vim/autoload/
|
|
```
|
|
|
|
|
|
## Quick Tutorial
|
|
|
|
Open or create a New File:
|
|
|
|
```sh
|
|
vim index.html
|
|
```
|
|
|
|
Type ("\_" is the cursor position):
|
|
|
|
html:5_
|
|
|
|
Then type `<c-y>,` (<kbd>Ctrl</kbd><kbd>y</kbd><kbd>,</kbd>), and you should see:
|
|
|
|
```html
|
|
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title></title>
|
|
</head>
|
|
<body>
|
|
_
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
[More Tutorials](https://raw.githubusercontent.com/mattn/emmet-vim/master/TUTORIAL)
|
|
|
|
|
|
## Enable in different mode
|
|
|
|
If you don't want to enable emmet in all modes,
|
|
you can use set these options in `vimrc`:
|
|
|
|
```vim
|
|
let g:user_emmet_mode='n' "only enable normal mode functions.
|
|
let g:user_emmet_mode='inv' "enable all functions, which is equal to
|
|
let g:user_emmet_mode='a' "enable all function in all mode.
|
|
```
|
|
|
|
## Enable just for html/css
|
|
|
|
```vim
|
|
let g:user_emmet_install_global = 0
|
|
autocmd FileType html,css EmmetInstall
|
|
```
|
|
|
|
## Redefine trigger key
|
|
To remap the default `<C-Y>` leader:
|
|
|
|
```vim
|
|
let g:user_emmet_leader_key='<C-Z>'
|
|
```
|
|
|
|
Note that the trailing `,` still needs to be entered, so the new keymap would be `<C-Z>,`.
|
|
|
|
## Adding custom snippets
|
|
If you have installed the [web-api](https://github.com/mattn/webapi-vim) for **emmet-vim** you can also add your own snippets using a custom **snippets.json** file.
|
|
|
|
Once you have installed the [web-api](https://github.com/mattn/webapi-vim) add this line to your **.vimrc**:
|
|
```
|
|
let g:user_emmet_settings = webapi#json#decode(join(readfile(expand('~/.snippets_custom.json')), "\n"))
|
|
```
|
|
You can change the **path** to your **snippets_custom.json** according to your preferences.
|
|
|
|
[Here](http://docs.emmet.io/customization/snippets/) you can find instructions about creating your customized **snippets.json** file.
|
|
|
|
## Snippet to add meta tag for responsiveness
|
|
Update this in your .vimrc file.
|
|
|
|
|
|
let g:user_emmet_settings = {
|
|
\ 'variables': {'lang': 'ja'},
|
|
\ 'html': {
|
|
\ 'default_attributes': {
|
|
\ 'option': {'value': v:null},
|
|
\ 'textarea': {'id': v:null, 'name': v:null, 'cols': 10, 'rows': 10},
|
|
\ },
|
|
\ 'snippets': {
|
|
\ 'html:5': "<!DOCTYPE html>\n"
|
|
\ ."<html lang=\"${lang}\">\n"
|
|
\ ."<head>\n"
|
|
\ ."\t<meta charset=\"${charset}\">\n"
|
|
\ ."\t<title></title>\n"
|
|
\ ."\t<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n"
|
|
\ ."</head>\n"
|
|
\ ."<body>\n\t${child}|\n</body>\n"
|
|
\ ."</html>",
|
|
\ },
|
|
\ },
|
|
\}
|
|
|
|
|
|
## Project Authors
|
|
|
|
[Yasuhiro Matsumoto](http://mattn.kaoriya.net/)
|
|
|
|
## FAQ
|
|
|
|
* Pressing ctrl+y+, doesn't work
|
|
|
|
Probably you set `timeoutlen=0`. Most of Vim plugins which using key-mappings does not work with `timeoutlen=0`.
|
|
|
|
## Links
|
|
|
|
### Emmet official site:
|
|
|
|
* <http://emmet.io/>
|
|
|
|
### zen-coding official site:
|
|
|
|
* <http://code.google.com/p/zen-coding/>
|
|
|
|
### emmet.vim:
|
|
|
|
* <https://mattn.github.io/emmet-vim/>
|
|
|
|
### development repository:
|
|
|
|
* <https://github.com/mattn/emmet-vim>
|
|
|
|
### my blog posts about zencoding-vim:
|
|
|
|
* <http://mattn.kaoriya.net/software/vim/20100222103327.htm>
|
|
|
|
* <http://mattn.kaoriya.net/software/vim/20100306021632.htm>
|
|
|
|
### Japanese blog posts about zencoding-vim:
|
|
|
|
* <http://d.hatena.ne.jp/idesaku/20100424/1272092255>
|
|
|
|
* <http://d.hatena.ne.jp/griefworker/20110118/vim_zen_coding>
|
|
|
|
* <http://d.hatena.ne.jp/sakurako_s/20110126/1295988873>
|
|
|
|
* <http://looxu.blogspot.jp/2010/02/zencodingvimhtml.html>
|
|
|
|
### A Chinese translation of the tutorial:
|
|
|
|
* <http://www.zfanw.com/blog/zencoding-vim-tutorial-chinese.html>
|
|
|