Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wlemuel/vim-tldr
tldr client for vim/neovim
https://github.com/wlemuel/vim-tldr
tldr vim vim-plugin viml
Last synced: about 2 months ago
JSON representation
tldr client for vim/neovim
- Host: GitHub
- URL: https://github.com/wlemuel/vim-tldr
- Owner: wlemuel
- License: mit
- Created: 2019-03-24T08:28:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T05:37:00.000Z (over 1 year ago)
- Last Synced: 2024-06-19T00:40:45.327Z (4 months ago)
- Topics: tldr, vim, vim-plugin, viml
- Language: Vim Script
- Size: 35.2 KB
- Stars: 55
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vim-tldr
[](https://app.codacy.com/app/wlemuel/vim-tldr?utm_source=github.com&utm_medium=referral&utm_content=wlemuel/vim-tldr&utm_campaign=Badge_Grade_Dashboard)
[tldr](http://tldr-pages.github.io/) client for vim/neovim
## Requirements
- Vim 7.0+
- unzip (*unix)
- curl (*unix)
## Screenshot
## Installation
vim-tldr follows the standard runtime path structure. Below are some helper lines
for popular package managers:
- [Vim 8 packages](http://vimhelp.appspot.com/repeat.txt.html#packages)
- `git clone https://github.com/wlemuel/vim-tldr.git ~/.vim/pack/plugins/start/vim-tldr`
- [Pathogen](https://github.com/tpope/vim-pathogen)
- `git clone https://github.com/wlemuel/vim-tldr.git ~/.vim/bundle/vim-tldr`
- [vim-plug](https://github.com/junegunn/vim-plug)
- `Plug 'wlemuel/vim-tldr'`
- [Vundle](https://github.com/VundleVim/Vundle.vim)
- `Plugin 'wlemuel/vim-tldr'`
## Basic Usage
- Run `:Tldr [command]` to find the tldr of command.
- Run `:TldrUpdateDocs` to get or update tldr docs.
## Basic Options
- Change the default tldr directory path:
```vim
let g:tldr_directory_path = '~/.cache/tldr'
```
- Change the tldr split window type `["horizontal", "vertical", "tab"]`, Default is "vertical":
```vim
let g:tldr_split_type = 'horizontal'
```
- Set language, Default is English:
The supported language list until 2021-12-26.
| option | language |
|--------|----------------------|
| ar | Arabic |
| bn | Bengali |
| bs | Bosnian |
| da | Danish |
| de | German |
| en | English |
| es | Spanish |
| fa | Persian |
| fr | French |
| hi | Hindi |
| id | Indonesian |
| it | Italian |
| ja | Japanese |
| ko | Korean |
| ml | Malayalam |
| ne | Nepali |
| nl | Dutch |
| no | Norwegian |
| pl | Polish |
| pt_BR | Brazilian Portuguese |
| pt_PT | Portuguese |
| ro | Romanian |
| ru | Russian |
| sh | Serbo-Croatian |
| sr | Serbian |
| sv | Swedish |
| ta | Tamil |
| th | Thai |
| tr | Turkish |
| uk | Ukrainian |
| uz | Uzbek |
| zh | Chinese |
| zh_TW | Traditional Chinese |
If the tldr of specific language is missing, English will be the fallback.
The contribution to tldr project is welcome, please refer to [Tldr Contributing](https://github.com/tldr-pages/tldr#contributing) for details.
```vim
let g:tldr_language = 'zh'
```
Check `:help tldr-options` for other options.
## Appendix
I'd be glad to receive patches,
comments and your considered criticism.
_Have fun with vim-tldr!_