Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vim plugin with documentation #705

Closed
wants to merge 3 commits into from

Conversation

HugoNikanor
Copy link

I felt a lack of help inside vim. So I put most of the vim-plug README into a vim help page.
That help page is here included in a plugin, for easy installation.

Created a sub-directory from the main directory
which is a vim plugin for vim-plug's documentation.
Moved most of the information from the main README into vim-plug.txt.
Some info was left out, due to it not being needed once vim-plug is
installed. Such as what vim-plug is and how to install it.
@partounian
Copy link

partounian commented Nov 16, 2017

Thanks so much! I always have had trouble finding the

Plug options vim-plug-plug-options

@junegunn
Copy link
Owner

Thanks for your work. Actually, I wrote a Markdown-to-Vimdoc converter, so I'll just add the file myself.

I've been reluctant to add Vim help file as I didn't want to maintain two copies of the document (you can find a couple of old discussion on this) but the feature set of vim-plug is now virtually frozen, I think I can handle that now.

Will simply add it to doc directory, as it should feel a bit strange to the users who are not familiar with the concept of &runtimepath that they have to specify rtp option. So it becomes:

" (Optional) If you want to register Vim help file for vim-plug 
Plug 'junegunn/vim-plug'

@junegunn junegunn closed this in 96375cb Nov 26, 2017
@HugoNikanor
Copy link
Author

HugoNikanor commented Nov 27, 2017 via email

@junegunn
Copy link
Owner

Manually. I can set up a pre-commit git hook to verify that the file is updated accordingly, but it's still a manual process.

@HugoNikanor
Copy link
Author

HugoNikanor commented Nov 27, 2017 via email

@junegunn junegunn mentioned this pull request May 29, 2019
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants