{"id":13898387,"url":"https://github.com/michaelb/vim-tips","last_synced_at":"2025-03-03T07:11:18.397Z","repository":{"id":52897117,"uuid":"289691302","full_name":"michaelb/vim-tips","owner":"michaelb","description":"Short plugin to display tips at startup","archived":false,"fork":false,"pushed_at":"2022-10-06T17:00:54.000Z","size":100,"stargazers_count":26,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-02T04:38:42.378Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/michaelb.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}},"created_at":"2020-08-23T13:26:39.000Z","updated_at":"2024-12-09T12:40:55.000Z","dependencies_parsed_at":"2022-08-23T08:50:19.378Z","dependency_job_id":null,"html_url":"https://github.com/michaelb/vim-tips","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelb%2Fvim-tips","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelb%2Fvim-tips/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelb%2Fvim-tips/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelb%2Fvim-tips/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelb","download_url":"https://codeload.github.com/michaelb/vim-tips/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241622615,"owners_count":19992504,"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":[],"created_at":"2024-08-06T18:04:16.353Z","updated_at":"2025-03-03T07:11:18.373Z","avatar_url":"https://github.com/michaelb.png","language":"Vim Script","funding_links":[],"categories":["Vim Script"],"sub_categories":[],"readme":"# Vim-Tips\n\nA simple plugin that display a tip at startup, no configuration required\n\n![](example.png)\n\n## Installation\n\nUse your favorite plugin manager; ex `vim-plug`:\n\n```vim\nPlug 'michaelb/vim-tips'\n```\n\nvim-tips should be, vim (incl \u003c8), neovim, linux, macOS and windows compatible\n\n## Usage\n\nvim-tips prints a message in the command area at startup.\n\nHowever, you can request tips by calling the function `GetTip()` to get a string value usable in vimscript. Ex:\n\n```\nlet tip = GetTip()\necho tip\n```\n\nDon't forget to load vim-tips beforehand if necessary (you need it at startup) by preceding calls to GetTip() by a \n`runtime plugin/vim-tips.vim`\n\n## Add tips to vim-startify (courtesy of R0LA1mRifcF8yAkk)\nTo display a tip (and not a quote) in your vim-startify you can include the following in your config file:\n\n`let g:startify_custom_header = 'startify#pad([GetTip()])'`\n\nYou'll probably also want to deactivate the basic tip display at startup.\n\n\n## Important note\n\nIf you are using an autoload session restore (from mksession) it displays a message and therefore hide the vim-tips message.\n\n\n\n## Your own mappings (deprecated for now, didn't work very well anyway)\n\nvim-tips reads from your vim/neovim config file and displays the lines it recognizes.\n\nFor example;\n`nnoremap gd :ALEGoToDefinition`\nwill display the tip \"Config =\u003e gd :ALEGoToDefinition (normal mode)\".\n\nIf you'd like to display tips more often (and see less mappings from your own config file), you can adjust the tips frequency via\n`let g:vim_tips_tips_frequency=0.5` (with a value between 0.0 and 1.0, higher value increase tips frequency)\n\n## Hiding the message at startup\n\nYou can specify `let g:vim_tips_display_at_startup=0` (default :`1`) to not have a message displayed at startup. You can then get tips by using the `GetTip()` function\n\n##Special thanks\n\nTo @R0LA1mRifcF8yAkk and @Kamilcuk who have opened so many relevant issues, and helped me catch edge cases and suggested improvements.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelb%2Fvim-tips","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelb%2Fvim-tips","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelb%2Fvim-tips/lists"}