{"id":15978331,"url":"https://github.com/tandrewnichols/vim-whelp","last_synced_at":"2025-04-04T17:50:07.063Z","repository":{"id":142028527,"uuid":"149807834","full_name":"tandrewnichols/vim-whelp","owner":"tandrewnichols","description":"A historical record of your help queries","archived":false,"fork":false,"pushed_at":"2018-09-25T16:57:49.000Z","size":200,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T03:16:25.402Z","etag":null,"topics":["vim","vim-plugin"],"latest_commit_sha":null,"homepage":"","language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tandrewnichols.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-21T19:21:55.000Z","updated_at":"2019-01-30T13:40:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"a0a718c0-42d5-4c92-89c5-abbd5d8b02c7","html_url":"https://github.com/tandrewnichols/vim-whelp","commit_stats":{"total_commits":27,"total_committers":1,"mean_commits":27.0,"dds":0.0,"last_synced_commit":"507449981670af4effc81e0b248a17d0e81bdb69"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tandrewnichols%2Fvim-whelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tandrewnichols%2Fvim-whelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tandrewnichols%2Fvim-whelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tandrewnichols%2Fvim-whelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tandrewnichols","download_url":"https://codeload.github.com/tandrewnichols/vim-whelp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226196,"owners_count":20904465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["vim","vim-plugin"],"created_at":"2024-10-07T23:08:38.681Z","updated_at":"2025-04-04T17:50:07.042Z","avatar_url":"https://github.com/tandrewnichols.png","language":"Vim script","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vim-Whelp\n\nKeep track of what you've looked up in vim's help. The name, like all my plugins, is just a word that contains the main concept (\"help\" in this case), but I also think of it as \"Write help.\"\n\n## Overview\n\nYou know how some people highlight words they've looked up in the dictionary? I'm not one of those people. But on a whim, I did write this little plugin to keep track of things you've looked up in vim's help. Every time you run `:h something` or `:help something`, vim-whelp records it in a text file. You can then later open that file and browse around and even reopen the help entry.\n\n## Requirements\n\nI'm not exactly sure . . . I'm guessing this works best with vim 7.4 and later, but I haven't feature checked. Some functions use `strftime` which isn't available on all distributions. You can check with `exists('*strftime')`. If you don't have it, this plugin won't break vim . . . it just won't do certain date-related things.\n\n## Installation\n\nIf you don't have a preferred installation method, I really like vim-plug and recommend it.\n\n#### Manual\n\nClone this repository and copy the files in plugin/, autoload/, and doc/ to their respective directories in your vimfiles, or copy the text from the github repository into new files in those directories. Make sure to run `:helptags`.\n\n#### Plug (https://github.com/junegunn/vim-plug)\n\nAdd the following to your vimrc, or something sourced therein:\n\n```vim\nPlug 'tandrewnichols/vim-whelp'\n```\n\nThen install via `:PlugInstall`\n\n#### Vundle (https://github.com/gmarik/Vundle.vim)\n\nAdd the following to your vimrc, or something sourced therein:\n\n```vim\nPlugin 'tandrewnichols/vim-whelp'\n```\n\nThen install via `:BundleInstall`\n\n#### NeoBundle (https://github.com/Shougo/neobundle.vim)\n\nAdd the following to your vimrc, or something sourced therein:\n\n```vim\nNeoBundle 'tandrewnichols/vim-whelp'\n```\n\nThen install via `:BundleInstall`\n\n#### Pathogen (https://github.com/tpope/vim-pathogen)\n\n```sh\ngit clone https://github.com/tandrewnichols/vim-whelp.git ~/.vim/bundle/vim-whelp\n```\n\n## Usage\n\nThe short version is \"keep using help the way you normally do.\" This plugin just records all the things you look up (and _when_ you looked them up), and then you can review them at your leisure.\n\n## Commands\n\n### :Whelp\n\nView previous help entries in the current window.\n\n### :VWhelp[!]\n\nView previous help entries in a vertical split. When bang is provided, reverse the normal `splitbelow` settings.\n\n### :SWhelp[!]\n\nView previous help entries in a horizontal split. When bang is provided, reverse the normal `splitright` settings.\n\n### :TWhelp\n\nView previous Help entries in a new tab.\n\n### :ClearWhelp\n\nRemove all previously recorded help entries.\n\n### :DedupeWhelp\n\nRemove all duplicate help terms, keeping only the most recent entry.\n\n### :PruneWhelp {age}\n\nRemove all previously recorded help entries older than {age} (in days).\n\n## Whelp file\n\nBy default `vim-whelp` writes help entries to `$HOME/.vim/whelp.txt`, but you can override this location by setting `g:whelp_file`. When you use any of `:Whelp`, `:VWhelp`, `:SWhelp`, or `:TWhelp`, the whelp file will open in the corresponding buffer; it looks something like this:\n\n![whelp in a vertical split](./whelp.png)\n\nWhen whelp is opened in a split, leaving the whelp buffer (e.g. via `\u003cC-w\u003eh`) will autoclose the buffer. When whelp is the active buffer, the following mappings are available:\n\n### K\n\nReopen the help for this entry.\n\n### [count]-\n\nDelete [count] entries.\n\n## Options\n\nThe following options are available to configure the behavior of whelp.\n\n### g:whelp_file\n\nWhere to save help entries.\n\nDefault: `$HOME/.vim/whelp.txt`\n\n### g:whelp_autoclose\n\nWhether to autoclose the whelp buffer on BufLeave when it's opened in a split.\n\nDefault: 1\n\n### g:whelp_remove_entry_mapping\n\nMapping to remove entries from the whelp file.\n\nDefault: -\n\n### g:whelp_reopen_entry_mapping\n\nMapping to reopen the help for an entry in the whelp file.\n\nDefault: K\n\n## Contributing\n\nI always try to be open to suggestions, but I do still have opinions about what this should and should not be so . . . it never hurts to ask before investing a lot of time on a patch.\n\n## License\n\nSee [LICENSE](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftandrewnichols%2Fvim-whelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftandrewnichols%2Fvim-whelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftandrewnichols%2Fvim-whelp/lists"}