Editor setup

All editors use the same LSP server, so features are consistent across editors: autocompletion, type checking, go-to-definition, find references, semantic rename, hover info, diagnostics, formatting, and code actions.

Neovim ​

The Neovim plugin registers the LSP, tree-sitter grammars, and file type detection automatically. Requires Neovim 0.10+ and curl on your PATH for automatic binary download.

lazy.nvim ​

{
  "huydo862003/typerighter",
  tag = "v0.15.1",
  lazy = false,
  init = function()
    local base = vim.fn.stdpath("data") .. "/lazy/typerighter/editors/nvim"
    vim.opt.runtimepath:prepend(base)
    vim.filetype.add({ extension = { td = "typedown" } })
    for _, f in ipairs(vim.fn.glob(base .. "/plugin/*.lua", false, true)) do
      vim.cmd.source(f)
    end
  end,
}

mini.deps ​

MiniDeps.add("huydo862003/typerighter")
local base = vim.fn.stdpath("data") .. "/site/pack/deps/opt/typerighter/editors/nvim"
vim.opt.runtimepath:prepend(base)
vim.filetype.add({ extension = { td = "typedown" } })
for _, f in ipairs(vim.fn.glob(base .. "/plugin/*.lua", false, true)) do
  vim.cmd.source(f)
end

NixOS ​

On NixOS, the auto-downloaded binary will not work because it is dynamically linked. Install via the flake instead:

# flake.nix
{
  inputs.typerighter = {
    url = "github:huydo862003/typerighter";
    inputs.nixpkgs.follows = "nixpkgs";
  };
}

environment.systemPackages = [
  typerighter.packages.${system}.default
];

This puts both typedown-lsp and typedown-rpc on your PATH. The plugin picks them up automatically.

Commands and keybindings ​

Standard LSP keybindings work: gd (go to definition), gr (find references), K (hover), <leader>ca (code actions), <leader>rn (rename).

List continuation works out of the box: pressing enter on a list item continues the list, pressing enter on an empty item exits the list.

VS Code ​

The VS Code extension provides syntax highlighting, the full LSP client, a paste handler for clipboard images, and list continuation on enter.

Installation ​

The extension is not yet published on the VS Code Marketplace. Download the .vsix file for your platform from the GitHub Releases page, then install it manually:

1. Open VS Code

2. Ctrl+Shift+P -> "Extensions: Install from VSIX..."

3. Select the downloaded .vsix file

Keybindings ​

Standard VS Code keybindings apply: Ctrl+Space (completions), F2 (rename), Ctrl+. (code actions), Ctrl+Shift+F (format), Ctrl+Shift+V (paste image as asset).

Zed ​

The Zed extension provides tree-sitter grammars and LSP integration. Install from the Zed extension marketplace.