---

Ⅰ. 插件描述

tldr client for vim/neovim

Ⅱ. 基本信息

创建日期：  2019-03-24 使用用户：  1 Github星：  14 插件作者：  Steve Lemuel

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'wlemuel/vim-tldr'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'wlemuel/vim-tldr'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'wlemuel/vim-tldr'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/wlemuel/vim-tldr

Ⅳ. 文档说明

# vim-tldr

tldr client for vim/neovim

Requirements

• Vim 7.0+
• unzip
• curl

Screenshot

Installation

vim-tldr follows the standard runtime path structure. Below are some helper lines
for popular package managers:

• Vim 8 packages

  • git clone https://github.com/wlemuel/vim-tldr.git ~/.vim/pack/plugins/start/vim-tldr

• Pathogen

  • git clone https://github.com/wlemuel/vim-tldr.git ~/.vim/bundle/vim-tldr

• vim-plug

  • Plug 'wlemuel/vim-tldr'

• Vundle

  • 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:

  let g:tldr_directory_path = '~/.cache/tldr'

• Change the tldr split window type ["horizontal", "vertical", "tab"], Default is "vertical":

  let g:tldr_split_type = 'horizontal'

• Set language, Default is English:

  The supported language list until 2020-01-17.

  option	language
  en	English
  es	Spanish
  fr	French
  it	Italian
  ko	Korean
  pt-BR	Brazilian Portuguese
  ta	Tamil
  zh	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 for details.

  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!