{"id":13898728,"url":"https://github.com/wincent/vim-docvim","last_synced_at":"2025-02-23T21:22:49.659Z","repository":{"id":66829549,"uuid":"55040373","full_name":"wincent/vim-docvim","owner":"wincent","description":"Syntax highlighting for Docvim comments","archived":false,"fork":false,"pushed_at":"2024-03-29T13:00:40.000Z","size":26,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-05T15:43:34.233Z","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/wincent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2016-03-30T07:03:24.000Z","updated_at":"2023-10-08T14:46:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"f912f2e3-b6d5-4476-a052-0993939e296f","html_url":"https://github.com/wincent/vim-docvim","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-docvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-docvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-docvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wincent%2Fvim-docvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wincent","download_url":"https://codeload.github.com/wincent/vim-docvim/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240380379,"owners_count":19792286,"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:25.742Z","updated_at":"2025-02-23T21:22:49.622Z","avatar_url":"https://github.com/wincent.png","language":"Vim Script","funding_links":[],"categories":["Vim Script"],"sub_categories":[],"readme":"\n# docvim\u003ca name=\"docvim-docvim\" href=\"#user-content-docvim-docvim\"\u003e\u003c/a\u003e\n\n\u003cp align=\"right\"\u003e\u003ca name=\"vim-docvim\" href=\"#user-content-vim-docvim\"\u003e\u003ccode\u003evim-docvim\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\n## Intro\u003ca name=\"docvim-intro\" href=\"#user-content-docvim-intro\"\u003e\u003c/a\u003e\n\nvim-docvim provides additional syntax highlighting for Vim script files that contain embedded docvim comments.\n\ndocvim (the tool, not this plug-in) is a documentation generator that processes those embedded comments and produces documentation in Markdown and Vim \u0026quot;help\u0026quot; formats. To avoid confusion, this document refers to the Vim plug-in as \u0026quot;vim-docvim\u0026quot; and the separate generation tool as \u0026quot;docvim\u0026quot;.\n\n\n## Installation\u003ca name=\"docvim-installation\" href=\"#user-content-docvim-installation\"\u003e\u003c/a\u003e\n\nTo install vim-docvim, use your plug-in management system of choice.\n\nIf you don't have a \u0026quot;plug-in management system of choice\u0026quot;, I recommend Pathogen (https://github.com/tpope/vim-pathogen) due to its simplicity and robustness. Assuming that you have Pathogen installed and configured, and that you want to install vim-docvim into `~/.vim/bundle`, you can do so with:\n\n```\ngit clone https://github.com/wincent/vim-docvim.git ~/.vim/bundle/vim-docvim\n```\n\nAlternatively, if you use a Git submodule for each Vim plug-in, you could do the following after `cd`-ing into the top-level of your Git superproject:\n\n```\ngit submodule add https://github.com/wincent/vim-docvim.git ~/vim/bundle/vim-docvim\ngit submodule init\n```\n\nTo generate help tags under Pathogen, you can do so from inside Vim with:\n\n```\n:call pathogen#helptags()\n```\n\n\n## Related\u003ca name=\"docvim-related\" href=\"#user-content-docvim-related\"\u003e\u003c/a\u003e\n\n\n### Docvim\u003ca name=\"docvim-docvim\" href=\"#user-content-docvim-docvim\"\u003e\u003c/a\u003e\n\nThe Docvim tool itself is a Haskell module, available at:\n\nhttp://hackage.haskell.org/package/docvim\n\nSource code:\n\n- https://github.com/wincent/docvim\n- https://gitlab.com/wincent/docvim\n- https://bitbucket.org/ghurrell/docvim\n\n\n## Website\u003ca name=\"docvim-website\" href=\"#user-content-docvim-website\"\u003e\u003c/a\u003e\n\nSource code for vim-docvim:\n\n- https://github.com/wincent/vim-docvim\n- https://gitlab.com/wincent/vim-docvim\n- https://bitbucket.org/ghurrell/vim-docvim\n\nOfficial releases are listed at:\n\nhttp://www.vim.org/scripts/script.php?script_id=5758\n\n\n## License\u003ca name=\"docvim-license\" href=\"#user-content-docvim-license\"\u003e\u003c/a\u003e\n\nCopyright (c) 2015-present Greg Hurrell\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u0026quot;Software\u0026quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \u0026quot;AS IS\u0026quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n\n## Development\u003ca name=\"docvim-development\" href=\"#user-content-docvim-development\"\u003e\u003c/a\u003e\n\n\n### Contributing patches\u003ca name=\"docvim-contributing-patches\" href=\"#user-content-docvim-contributing-patches\"\u003e\u003c/a\u003e\n\nPatches can be sent via mail to greg@hurrell.net, or as GitHub pull requests at: https://github.com/wincent/vim-docvim/pulls\n\n\n### Cutting a new release\u003ca name=\"docvim-cutting-a-new-release\" href=\"#user-content-docvim-cutting-a-new-release\"\u003e\u003c/a\u003e\n\nAt the moment the release process is manual:\n\n- Perform final sanity checks and manual testing\n- Update the \u003cstrong\u003e[`docvim-history`](#user-content-docvim-history)\u003c/strong\u003e section of the documentation\n- Verify clean work tree:\n\n```\ngit status\n```\n\n- Tag the release:\n\n```\ngit tag -s -m \"$VERSION release\" $VERSION\n```\n\n- Publish the code:\n\n```\ngit push origin main --follow-tags\ngit push github main --follow-tags\n```\n\n- Produce the release archive:\n\n```\ngit archive -o vim-docvim-$VERSION.zip HEAD -- .\n```\n\n- Upload to http://www.vim.org/scripts/script.php?script_id=5758\n\n\n## Authors\u003ca name=\"docvim-authors\" href=\"#user-content-docvim-authors\"\u003e\u003c/a\u003e\n\nvim-docvim is written and maintained by Greg Hurrell \u0026lt;greg@hurrell.net\u0026gt;.\n\n\n## History\u003ca name=\"docvim-history\" href=\"#user-content-docvim-history\"\u003e\u003c/a\u003e\n\n\n### 1.0 (25 December 2018)\u003ca name=\"docvim-10-25-december-2018\" href=\"#user-content-docvim-10-25-december-2018\"\u003e\u003c/a\u003e\n\n- Initial release.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwincent%2Fvim-docvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwincent%2Fvim-docvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwincent%2Fvim-docvim/lists"}