adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

patch 9.1.0836: The vimtutor can be improved

Browse Source 
Problem:  the vimtutor can be improved
Solution: port and include the interactive vimtutor plugin from Neovim
          (by Felipe Morales) (Yegappan Lakshmanan)

closes: #6414

Signed-off-by: Christian Brabandt <cb@256bit.org>
Signed-off-by: Yegappan Lakshmanan <yegappan@yahoo.com>
This commit is contained in:
Yegappan Lakshmanan
2024-11-03 10:49:23 +01:00
committed by Christian Brabandt
parent 6eda269600
commit a54816b884
19 changed files with 1752 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
runtime/doc/pi_tutor.txt Normal file
View File

@ -0,0 +1,51 @@
*pi_tutor.txt* For Vim version 9.1. Last change: 2024 Nov 02
INTERACTIVE TUTORIALS FOR VIM *vim-tutor-mode*
vim-tutor-mode provides a system to follow and create interactive tutorials
for vim and third party plugins. It replaces the venerable `vimtutor` system.
==============================================================================
1. Usage *vim-tutor-usage*
vim-tutor-mode tutorials are hypertext documents, they have rich text and
contain links. To stand out from the rest of the text, links are underlined.
You can follow them by placing the cursor over them and pressing <Enter>, or
by double-clicking them.
1.1 Commands
------------
*:Tutor*
:Tutor {tutorial} Opens a tutorial. Command-line completion for
{tutorial} is provided, the candidates are a list of
'.tutor' files found in the 'tutor/' folder in
the 'runtimepath'. Tutorials prefixed with 'vim-' will
always be shown first.
If no {tutorial} is provided, the command starts the
'vim-01-beginner' tutorial, which is equivalent to
Vim's `vimtutor`.
=============================================================================
2. Creating tutorials *vim-tutor-create*
Writing vim-tutor-mode tutorials is easy. For an overview of the format used,
please consult the 'tutor.tutor' file: >
:Tutor tutor
<
New tutorials must be placed in the 'tutor/' folder in the 'runtimepath'
to be detected by the :Tutor command.
It is recommended to use a less formal style when writing tutorials than in
regular documentation (unless the content requires it).
============================================================================
3. Contributing
Development of the plugin is done over at github [1]. Feel free to report
issues and make suggestions.
[1]: https://github.com/fmoralesc/vim-tutor-mode
" vim: set ft=help :