Adds a comprehensive Vim :help reference for Lua 5.1 built-in functions and libraries.
nvim-luaref is a Neovim/Vim plugin that adds comprehensive documentation for Lua 5.1's built-in functions and standard libraries directly into the editor's help system. It extracts content from the official Lua 5.1 Reference Manual and makes it accessible via standard Vim `:help` commands, eliminating the need to consult external documentation while coding.
Neovim and Vim users who write Lua scripts, configure their editors with Lua, or develop Lua-based plugins and want integrated documentation access.
It provides accurate, editor-native Lua documentation that respects Vim's help system conventions, supports multiple languages, and filters out irrelevant implementation details, making Lua development more efficient within Vim environments.
Add a vim :help reference for lua
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Extracts all built-in functions and standard libraries directly from the official Lua 5.1 manual, ensuring accurate and comprehensive documentation for that version, as stated in the description.
Provides documentation in English, German, Spanish, and Portuguese, making it accessible to a wider audience, as highlighted in the README's language list.
Accessible via standard `:help` commands, fitting seamlessly into Vim workflows without requiring external tools, which improves efficiency for editor-based Lua scripting.
Removes C implementation details irrelevant to Lua users, focusing purely on Lua language usage, as mentioned in the description to keep the documentation clean and relevant.
Does not cover newer Lua versions or non-standard libraries, which can be a significant drawback for modern Lua development or projects using updated features.
The README admits there are still formatting problems, particularly around equals signs, which can affect readability and require manual fixes or issue reporting.
Lacks interactive elements like code execution or advanced hyperlinking, making it less versatile compared to web-based documentation tools with richer functionality.