mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
doc: Add transition instructions to nvim_from_vim.txt
Also move introduction to Nvim and topic overview to nvim.txt. Reviewed-by: Michael Reed <Pyrohh@users.noreply.github.com> Reviewed-by: Justin M. Keyes <justinkz@gmail.com>
This commit is contained in:
committed by
Michael Reed
parent
5fc4c2d442
commit
61e6665652
24
runtime/doc/nvim.txt
Normal file
24
runtime/doc/nvim.txt
Normal file
@@ -0,0 +1,24 @@
|
||||
*nvim.txt* For Nvim. {Nvim}
|
||||
|
||||
|
||||
NVIM REFERENCE MANUAL *nvim*
|
||||
|
||||
|
||||
Introduction to Nvim *nvim-intro*
|
||||
|
||||
This is an introduction for Vim users who are just getting started with Nvim.
|
||||
It is not meant for Vim beginners. For a basic introduction to Vim,
|
||||
see |help.txt|.
|
||||
|
||||
1. Transitioning from Vim |nvim-from-vim|
|
||||
2. Differences from Vim |vim-differences|
|
||||
3. Msgpack-RPC |msgpack-rpc|
|
||||
4. Job control |job-control|
|
||||
5. Python plugins |nvim-python|
|
||||
6. Clipboard integration |nvim-clipboard|
|
||||
7. Remote plugins |remote-plugin|
|
||||
8. Provider infrastructure |nvim-provider|
|
||||
9. Integrated terminal emulator |nvim-terminal-emulator|
|
||||
|
||||
==============================================================================
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
48
runtime/doc/nvim_from_vim.txt
Normal file
48
runtime/doc/nvim_from_vim.txt
Normal file
@@ -0,0 +1,48 @@
|
||||
*nvim_from_vim.txt* For Nvim. {Nvim}
|
||||
|
||||
|
||||
NVIM REFERENCE MANUAL
|
||||
|
||||
|
||||
Transitioning from Vim *nvim-from-vim*
|
||||
|
||||
Nvim is emphatically a fork of Vim, so compatibility to Vim should be pretty
|
||||
good.
|
||||
|
||||
To start the transition, link your previous configuration so Nvim can use
|
||||
it:
|
||||
>
|
||||
ln -s ~/.vimrc ~/.nvimrc
|
||||
ln -s ~/.vim ~/.nvim
|
||||
<
|
||||
See |nvim-intro|, especially |nvim-python| and |nvim-clipboard|, for
|
||||
additional software you might need to install to use all of Nvim's features.
|
||||
|
||||
Your Vim configuration might not be entirely compatible with Nvim. For a
|
||||
full list of differences between Vim and Nvim, see |vim-differences|.
|
||||
|
||||
The |'ttymouse'| option, for example, was removed from Nvim (mouse support
|
||||
should work without it). If you use the same |vimrc| for Vim and Nvim,
|
||||
consider guarding |'ttymouse'| in your configuration like so:
|
||||
>
|
||||
if !has('nvim')
|
||||
set ttymouse=xterm2
|
||||
endif
|
||||
<
|
||||
Conversely, if you have Nvim specific configuration items, you could do
|
||||
this:
|
||||
>
|
||||
if has('nvim')
|
||||
tnoremap <Esc> <C-\><C-n>
|
||||
endif
|
||||
<
|
||||
For a more granular approach, use |exists()|:
|
||||
>
|
||||
if exists(':tnoremap')
|
||||
tnoremap <Esc> <C-\><C-n>
|
||||
endif
|
||||
<
|
||||
Now you should be able to explore Nvim more comfortably. Check |nvim| for more
|
||||
information.
|
||||
==============================================================================
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
@@ -1,26 +0,0 @@
|
||||
*nvim_intro.txt* For Nvim. {Nvim}
|
||||
|
||||
|
||||
NVIM REFERENCE MANUAL by Thiago de Arruda
|
||||
|
||||
|
||||
Introduction to Nvim *nvim* *nvim-intro*
|
||||
|
||||
This is an introduction for Vim users who are just getting started with Nvim.
|
||||
It is not meant for Vim beginners. For a basic introduction to Vim,
|
||||
see |help.txt|.
|
||||
|
||||
For now, it is just an index with the most relevant topics/features that
|
||||
differentiate Nvim from Vim:
|
||||
|
||||
1. Differences from Vim |vim-differences|
|
||||
2. Msgpack-RPC |msgpack-rpc|
|
||||
3. Job control |job-control|
|
||||
4. Python plugins |nvim-python|
|
||||
5. Clipboard integration |nvim-clipboard|
|
||||
6. Remote plugins |remote-plugin|
|
||||
7. Provider infrastructure |nvim-provider|
|
||||
8. Integrated terminal emulator |nvim-terminal-emulator|
|
||||
|
||||
==============================================================================
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
Reference in New Issue
Block a user