An interactive Lua and Neovim API tutorial — right inside your editor.

Requirements

• lua-language-server or emmylua_ls (optional, for LSP support — install via Mason or your system package manager)

With lazy.nvim:

return {
  "urtzienriquez/learnlua.nvim",
  cmd = "Learn",
}

Open the welcome page and table of contents:

:Learn

Open a specific lesson:

:Learn basics
:Learn coroutines
:Learn vim_lsp

return {
  "urtzienriquez/learnlua.nvim",
  dev = true,
  cmd = "Learn",
  opts = {
    lsp = "lua_ls",         -- or emmylua_ls
    -- default keymaps
    mappings = {
      open_editor = "<CR>", -- Inside code block
      submit_code = "<CR>", -- Inside editor
      test_code = "tc",
      close_editor = "q",
      close_lesson = "q",
      go_welcome = "gO",
      jump_lua = "gl",
      jump_nvim = "gn",
      jump_lesson = "<CR>", -- In lesson list
    },
  },
}

Each lesson is a markdown file with embedded code blocks and expected outputs. Press <CR> on any block to open a small split editor. Edit the code, press <CR> to run it — virtual text shows ✓ Correct! or ✗ with the difference between expected and actual output. Passing an exercise closes the editor automatically.

Inside of code editor, you can use "tc" (in normal mode) to test your code and see all the outputs of print commands.

LSP completions and diagnostics are available in the exercise editor if a compatible language server is installed.

Part I — Lua Language

• basics
• strings
• tables
• control_flow
• functions
• oop
• metatables
• iterators
• patterns
• error_handling
• coroutines
• modules
• io

Part II — Neovim API

• vim_api
• vim_options
• vim_keymaps
• vim_autocommands
• vim_buffers
• vim_highlights
• vim_usercmds
• vim_lsp
• vim_treesitter
• vim_config
• vim_plugin

GNU General Public License v3.0 — see LICENSE.