nvimdoc-ja

日本語に翻訳した Neovim 付属のヘルプを配布するためのプロジェクトです。

Tip

このプロジェクトは Neovim 用です。 Vim については こちら をご覧ください。

Warning

現在、未翻訳のファイルが多数あります。進捗は こちら 。

Usage

1. お使いのプラグインマネージャーでインストールしてください。

vim.pack

vim.pack.add({
  'https://github.com/vim-jp/nvimdoc-ja',
})

lazy.nvim

{
  'vim-jp/nvimdoc-ja',
  
  -- 任意で遅延読み込み
  keys = { '<F1>', '<Help>' },
  event = 'CmdlineEnter',
}

2. 言語設定、または 'helplang' を日本語に設定することで、翻訳されたヘルプファイルを利用することが可能になります。

-- 言語設定
vim.cmd('language ja_JP.utf8')

-- ヘルプファイルの言語設定
vim.o.helplang = 'ja,en'

3. :help コマンドの引数の末尾にフラグをつけることでも利用できます。

:help help@ja

Important

お使いの Neovim のバージョンとヘルプファイルのバージョンが異なるかもしれません。翻訳されたヘルプファイルの最上段に記載されている日本語訳の更新日時をご確認ください。

Contribution

間違いを見付けた場合、issue トラッカー でお知らせください。プルリクエストも大歓迎です。翻訳作業に協力していただける方は こちら をご覧ください。