{"id":15979024,"url":"https://github.com/luffah/vim-genhelp","last_synced_at":"2025-04-04T18:15:00.752Z","repository":{"id":93289902,"uuid":"136006222","full_name":"luffah/vim-genhelp","owner":"luffah","description":"Vim documentation tool for Vim scripts and plugins. Generate Helpfile and Readme.","archived":false,"fork":false,"pushed_at":"2020-12-12T16:51:12.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T03:24:23.953Z","etag":null,"topics":["helpfile","vim","vim-plugin","vimdoc"],"latest_commit_sha":null,"homepage":"","language":"Vim script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luffah.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-06-04T10:00:35.000Z","updated_at":"2020-12-12T16:51:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"f0ae5c8f-f12f-4820-86ea-deb1e04cfc16","html_url":"https://github.com/luffah/vim-genhelp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luffah%2Fvim-genhelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luffah%2Fvim-genhelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luffah%2Fvim-genhelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luffah%2Fvim-genhelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luffah","download_url":"https://codeload.github.com/luffah/vim-genhelp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226190,"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":["helpfile","vim","vim-plugin","vimdoc"],"created_at":"2024-10-07T23:40:44.653Z","updated_at":"2025-04-04T18:15:00.729Z","avatar_url":"https://github.com/luffah.png","language":"Vim script","funding_links":[],"categories":[],"sub_categories":[],"readme":"```\n      .--.                 .-. .-.      .-.\n     / .-_\\_  ___     ___  | | | | ___  | |\n    | | |___|/ o \\  ,'_  | | '-' |/ o \\ | | .--.\n     \\ '-'|   \\  '.| | | | | .-. | \\  '.| | | o |\n      '---'    '--''-' '-' '-' '-'  '--''--'| |'\n                                            | |\n                                            '-'\n\n** genhelp.vim -- Helper script to generate vim help files **\n\nLicense:     GPLv3\nLast Change: 2019-07-01\n```\nGenHelp generate vim help file for the current script.\n\n### HOW TO USE IT ?\n`:GenHelp` \n    Generate an help file from the current file.\n    Tag file will be written once the file is saved.\n\n`:GenReadme` \n    Generate a simple readme from the current file.\n\n### WHAT I HAVE TO DO BEFORE ?\nTo work with GenHelp, the vim script format shall be the following :\u003cpre\u003e\n   \" _filename_ -- _desc_\n   \" @Author:      _author_\n   \" @License:     _licence_\n   \" @Created:     _creation-date_\n   \" @Last Change: _modification-date_\n   \" @Revision:    _revision_\n   \" @Files\n   \"  ../plugin/_file_.vim\n   \"  ../autoload/_file_.vim\n   \"\n   \" @AsciiArt\n   \" _text_\n   \"\n   \" @Overview\n   \" _text_\n\n   \" Following properties can be located in any '@include' files\n\n   \" @Examples\n   \" _text_ : ```\n   \"     _codeblock_\n   \"```\n\n   \" @Fileformat g:_variablename_\n   \" _text_\n\n   \" @global g:_variablename_\n   \" _text_\n\n   \" @function _functionname_(_arguments_)\n   \" _text_\n\n   \" @command _commandname_ _arguments_\n   \" _text_\n\n   \" @usage _usecase_\n   \" _text_\n\n   \" @mapping _keys_\n   \" _text_\n\u003c/pre\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluffah%2Fvim-genhelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluffah%2Fvim-genhelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluffah%2Fvim-genhelp/lists"}