# vim_help

**Repository Path**: llwwff/vim_help

## Basic Information

- **Project Name**: vim_help
- **Description**: 我们的vim文档, 带备注, emoji
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: z支
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-03-13
- **Last Updated**: 2023-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

改用https://gitee.com/llwwff/doc_nvim

---


## Why

See
https://github.com/neovim/neovim/issues/18017

Vim's doc is too complicated to understand at a short time, 
so everyone can benefit from taking his own notes and have his own version of vimdoc.
Here is my version of vimdoc for neovim `0.6.1`. (I use the newest nvim release and it is 0.8.2 now,
and I've added something to this repo according to the new documentations)

## Usage
```vimL
plug 'https://gitee.com/llwwff/vim_help', {'do': ':helptags ALL', 'as':'help_me'} 
```

If you have deleted some help items and 
when using completion of help, those in **/share/nvim/runtime/doc annoys you:
 ```zsh 
rm /home/linuxbrew/.linuxbrew/Cellar/neovim/*/share/nvim/runtime/doc
# you may need to change this path to /usr/share or something alike
ln -sf ~/PL/help_me/doc  /home/linuxbrew/.linuxbrew/Cellar/neovim/*/share/nvim/runtime/
```  

## Taking notes in vimdoc
I modified the official ftplugin/help.vim and syntax/help.vim

Find them in cfg/nvim/ftplugin/help.vim from 
https://gitee.com/llwwff/dotF.git


## See also:

如何高效使用vim的help文档/手册(vimdoc)或改进? - kidneyball的回答 - 知乎
https://www.zhihu.com/question/522622970/answer/2402454732


如何将长文本, 按意群(成分)断句或换行, 转化为更容易理解, 更适合放进PPT的列表? - 胆大路野的回答 - 知乎
https://www.zhihu.com/question/522644260/answer/2395778565