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

Add initial vim help doc #11

Merged
merged 2 commits into from
Jul 25, 2024
Merged

Add initial vim help doc #11

merged 2 commits into from
Jul 25, 2024

Conversation

tuurep
Copy link
Collaborator

@tuurep tuurep commented Jul 24, 2024

Close #9

How's this for an initial document?

image

Of course, the g:vivify_instant_refresh bit depends on how we decide on #10, but it can be adjusted.

@tuurep
Copy link
Collaborator Author

tuurep commented Jul 24, 2024

So with this I learned that my plugin manager paq is the one who makes the help tags work, meaning :h vivify opens the right page and so on.

Probably true for all popular plugin managers.

From `:h help-writing`:

    When referring to an existing help tag and to create a hot-link,
    place the name between two bars ("|") eg. |help-writing|.

Gives a helpful highlight and allows using <C-]> on top of them
@jannis-baum
Copy link
Owner

So with this I learned that my plugin manager paq is the one who makes the help tags work, meaning :h vivify opens the right page and so on.

What did you mean by "makes the help tags work"? I don't use any plugin manager, just Vim's native plugin loading with the pack directory, and I have help tags. They don't load automatically (which is good because that would destroy Vim's super fast startup time) but I can load them with :helptags ALL

@tuurep
Copy link
Collaborator Author

tuurep commented Jul 25, 2024

What did you mean by "makes the help tags work"?

I expected that when I just have my vivify.vim folder in .../plugin/ and it has a doc/vivify.txt , I could then use :h vivify but that isn't how it works

@jannis-baum jannis-baum merged commit 43a3d2b into jannis-baum:main Jul 25, 2024
@tuurep
Copy link
Collaborator Author

tuurep commented Jul 25, 2024

Oh yeah one thing,

Since I say in the help doc "questions welcome", can we open Discussions on this (plugin) repo as well? :)

@tuurep tuurep deleted the add-vimdoc branch July 25, 2024 13:47
@jannis-baum
Copy link
Owner

Oh yeah one thing,

Since I say in the help doc "questions welcome", can we open Discussions on this (plugin) repo as well? :)

Done!

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.

:h vivify doc
2 participants