vim-tldr

October 27, 2022 ยท View on GitHub

Codacy Badge

tldr client for vim/neovim

Requirements

  • Vim 7.0+
  • unzip (*unix)
  • curl (*unix)

Screenshot

image

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 2021-12-26.

    optionlanguage
    arArabic
    bnBengali
    bsBosnian
    daDanish
    deGerman
    enEnglish
    esSpanish
    faPersian
    frFrench
    hiHindi
    idIndonesian
    itItalian
    jaJapanese
    koKorean
    mlMalayalam
    neNepali
    nlDutch
    noNorwegian
    plPolish
    pt_BRBrazilian Portuguese
    pt_PTPortuguese
    roRomanian
    ruRussian
    shSerbo-Croatian
    srSerbian
    svSwedish
    taTamil
    thThai
    trTurkish
    ukUkrainian
    uzUzbek
    zhChinese
    zh_TWTraditional 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!