{"id":15014625,"url":"https://github.com/davisdude/vim-love-docs","last_synced_at":"2025-04-12T08:13:33.187Z","repository":{"id":77354491,"uuid":"48947298","full_name":"davisdude/vim-love-docs","owner":"davisdude","description":"Vim plugin for LÖVE syntax highlighting and help file","archived":false,"fork":false,"pushed_at":"2020-08-07T14:21:14.000Z","size":1494,"stargazers_count":55,"open_issues_count":1,"forks_count":7,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-12T08:13:27.384Z","etag":null,"topics":["love2d","vim"],"latest_commit_sha":null,"homepage":"http://www.vim.org/scripts/script.php?script_id=5298","language":"Lua","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/davisdude.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}},"created_at":"2016-01-03T13:49:34.000Z","updated_at":"2025-04-01T20:30:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"e4d6dbfa-abdf-4e5d-af6a-c3320ab9f249","html_url":"https://github.com/davisdude/vim-love-docs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davisdude%2Fvim-love-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davisdude%2Fvim-love-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davisdude%2Fvim-love-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davisdude%2Fvim-love-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davisdude","download_url":"https://codeload.github.com/davisdude/vim-love-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248537144,"owners_count":21120711,"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":["love2d","vim"],"created_at":"2024-09-24T19:45:51.960Z","updated_at":"2025-04-12T08:13:33.167Z","avatar_url":"https://github.com/davisdude.png","language":"Lua","funding_links":[],"categories":["IDEs"],"sub_categories":[],"readme":"# Vim LOVE Docs\n\nVim syntax highlighting and helpfile for [LÖVE](http://love2d.org).\n\n## Building the Plugin\n\nThe source can be installed from [vim.org](http://www.vim.org/scripts/script.php?script_id=5298), or can be built, from the source. If you wish to build it from source, follow the steps below:\n\n1. Ensure that the following commands will run from the command line:\n\n    - `git`\n    - `lua`\n    - `vim`\n\n    You may also edit [`src/env.txt`](src/env.txt) to set custom values. For instance, if want to use Lua 5.2 instead of 5.3, you may change the line with `lua=\"lua\"` to be `lua=\"lua5.2\"` (assuming this command brings up the Lua 5.2 interpreter on your system).\n\n1. Next, run [`gen.bat`](src/gen.bat) (Windows) or [`gen.sh`](src/gen.sh) (Mac/Linux). This should generate the plugin code.\n\nYou may need to allow the files to be able to run. You need to do this for **every** file that ends with `.bat` if you're on Windows, or `.sh` for Mac/Linux. Windows users will need to \"Unblock\" the `.bat` files. See [here](https://blogs.msdn.microsoft.com/delay/p/unblockingdownloadedfile/) for how to unblock files. For Mac/Linux users, you will need to `chmod` the `.sh` files to allow execution.\n\n## Installing the Plugin\n\nInstallation varies depending on the plugin manager, but every method requires you to have the plugin built.\n\n### Pathogen:\n\nMove the directory containing the generated plugin code to `vimfiles\\bundle` (Windows) or `~/.vim/bundle` (Mac/Linux).\n\n### Vundle:\n\nPoint Vundle to the [`build`](https://github.com/davisdude/vim-love-docs/tree/build) branch of the repository:\n\n```\nPlugin 'https://github.com/davisdude/vim-love-docs/tree/build'\n```\n\n### No manager:\n\nMove the plugin code to their corresponding directory in `vimfiles\\` (Windows) or `~/.vim/` (Mac/Linux). See [here](https://vi.stackexchange.com/questions/613) for methods of how to install a plugin without a plugin manager.\n\n## Usage\n\nThis plugin is comprised of two parts: [syntax](#syntax) and the [help file](#help-file).\n\n### Syntax\n\nThe syntax portion of the plugin highlights LÖVE functions, such as `love.udpate`, `love.graphics.rectangle`, and more. It also highlights `conf.lua` flags, such as `t.console`, `t.window.width`, etc.\n\nThe style of the syntax highlighting can be changed by setting `g:lovedocs_color` in your `.vimrc`. You can set the string to any valid highlighting specification (see `:help highlight-args`). By default, it is set to `g:lovedocs_color = 'guifg=#ff60e2 ctermfg=206'`.\n\n### Help File\n\nThe plugin also includes help files for LÖVE, called `love.txt`. This file includes help for all of LÖVE's functions, as well as its types, enums, etc. It is generated from [love-api](https://github.com/love2d-community/love-api), so any discrepancies should be reported there.\n\nThe help file can be opened with `:help love.txt`, or by specifying a function, enum, or other identifier. The form for searching differs based on what is being searched, but each follows the same basic format: `:help love-SEARCH`.\n\n#### Functions\n\nFunctions are found first by their full name. For instance, if you wanted to see the parameters for `love.window.setMode`, you could search `:help love-love.window.setMode`.\n\nEach function features a brief description of what the function does, as well as the different forms of the function (called `Variants`) available. Each variant includes a function's return values and types (if any), as well as its parameters and their types (if any).\n\n#### Types\n\nTypes are found by their name. For instance, if I wanted to look up the `File` type, I would do so with `:help love-File`. The documentation includes a brief description of what the type handles, as well as a list of constructors, supertypes, subtypes, and functions.\n\nType functions can also be found with the function name, using self-invocation syntax. For instance, if you wanted to read about the `File` function `isEOF`, you would search `:help love-File:isEOF`.\n\n#### Enums\n\nSearching for enums is similar to searching for types: just use the name. For instance, if you wanted to read about the `BufferMode` enum, you would search `:help love-BufferMode`.\n\nConstants are separated by dashes. If you want to read about `BufferMode`'s constant `full`, you could search `:help love-BufferMode-full`.\n\n## Screenshots\n\nPlugins:\n\n- [gruvbox](https://github.com/morhetz/gruvbox)\n- [Rainbow](https://github.com/luochen1990/rainbow)\n- [vim-love-docs](https://github.com/davisdude/vim-love-docs)\n\n![](src/pics/screen1.png)\n![](src/pics/screen2.png)\n![](src/pics/screen3.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavisdude%2Fvim-love-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavisdude%2Fvim-love-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavisdude%2Fvim-love-docs/lists"}