Document g:emmet_install_only_plug
Nobody has claimed this yet.
- Dominant language
- Vim Script
- Stars
- 6.5k
- Forks
- 414
- PR merge metrics
- No merged PRs in 30d
Description
g:emmet_install_only_plug is a wonderful feature! It would be great to have it documented in both doc/emmet.txt and README.md (I only found the option by searching through the source code).
If you'd prefer to have help with this, I'm up for submitting a PR.
Here's some more detail for anyone running across this issue who might not be familiar with the option:
The following will cause emmet.vim to create <plug>(...) mappings, but not <c-y>... mappings:
let g:emmet_install_only_plug = 1
This allows you to define your own mappings without requiring all potential mappings to be created. I've found this to be handy when I want to:
- Create mappings for only some of Emmet's functionality, and
- prevent the remaining default
<c-y>...mappings from being created automatically, in order to - avoid a delay when using vim's built-in
ctrl-yandi_ctrl-ybindings (vim otherwise has to wait, to make sure you're not about to enter the second part of a longer mapping).
A simple example:
let g:emmet_install_only_plug = 1
nmap <Leader>, <plug>(emmet-expand-abbr)
imap <Leader>, <plug>(emmet-expand-abbr)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with plugin/emmet.vim around the option's definition, then compare the existing structure of doc/emmet.txt and README.md. Document g:emmet_install_only_plug in both files, including its effect on mappings and the example configuration shown in the issue; done means users can find and understand the option in either location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- vim
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100