kosorin / awesome-code-doc

awesome-code-doc

Code annotation for Awesome window manager. The annotations are supported by lua-language-server.

For more information about annotations see the wiki.

Installation

Clone this repository:

$ git clone https://github.com/kosorin/awesome-code-doc

Setup

NOTE: There are several ways to define the settings. See the wiki for more information.

.luarc.json (lua-ls)

Add a .luarc.json to your config directory. In it, add the path to the cloned repository to the workspace.library setting:

{
    "workspace.library": [
        "/path/to/awesome-code-doc"
    ]
}

VS Code (Lua extension)

Add the path to the cloned repository to the Lua.workspace.library setting:

{
  "Lua.workspace.library": ["/home/user/path/to/awesome-code-doc"]
}

Neovim (nvim-lspconfig plugin)

Add the path to the cloned repository to settings.Lua.workspace.library setting:

require("lspconfig")["lua_ls"].setup({
  settings = {
    Lua = {
      workspace = {
        library = {
          -- other library definition...
          ["/path/to/awesome-code-doc"] = true
        }
      }
    }
  }
})

Lite-XL (lite-xl-lsp plugin)

Add the path to the cloned repository to settings.Lua.workspace.library setting:

require("plugins.lsp").add_server {
    name = "lua-language-server",
    language = "lua",
    file_patterns = { "%.lua$" },
    command = { 'lua-language-server' },
    verbose = false,
    settings = {
        Lua = {
            workspace = {
                library = {
                    ["/path/to/awesome-code-doc"] = true
                }
            }
        }
    }
]