milisims / nvim-luaref

Add a vim :help reference for lua

This 'plugin' simply adds a reference for builtin lua functions, extracting both text and formatting from the Lua 5.1 Reference Manual. There are still formatting issues (particularly around equals), please search through and then submit an issue if you find one that is unreported!

Text referring to implementing lua into a host C program has largely been removed.

For example,

    :help lua_reference_toc
    :help math.pi
    :help coroutine.yield

Script generated documentation for lua 5.1 in languages: en, de, es, and pt.

nvim-luaref's Issues

Add parens to functions targets

For example, vim builtin :h insert() has parens, but :h tonumber() doesn't exist, just tonumber.

Ignore tags

Could you remove doc/tags from the repo and add it to gitignore? This file is generated by vim when you running :helptags and usually plugins require to generate after installation.

Add Russian language

Hi! Thank you a lot for the awesome plugin. Could you add Russian language version?

Limit Languages

It'd be nice if there was a way to only have some of the languages downloaded or added to helptags -- it's not a big deal to have the extra ones, but it'd be nice if they didn't show up in my tab complete.

Cool plugin :)

Add type targets

Like :help lua_type_userdata

Add metatable events/metamethods targets

Simple special case should add targets easily. :h metatable_add

Add control targets

Like :help lua_if

Clean up verbatim formatting

For example, see here:

written as `[[`, an opening long bracket of level 1 is written as `[`[=,

From Section 2.1.

Plagiarism!

https://www.vim.org/scripts/script.php?script_id=1291

Format paragraphs

Generally, I'd like most paragraphs to be formatted better, but blasting gq all over will not be very satisfactory.

Finding text that matches some 'paragraph' definition might get 90% of the job done.
For example, everything in :h lua_coroutines