must.nvim

RFC inside Neovim, because why not?

Usage

Run :Must <number> to open a new instance, which is opened in a shared tab for the session. You can also use :Must on its own to select an RFC, searching through items requires a picker that replaces vim.ui.select, otherwise you get nvim's native numbered list. Once inside, :Must toc or \ will toggle open the Table of Contents (if the RFC has one). gd within the main content body jumps to sections within the body, other RFCs, and other sections in other RFCs based on the cursor's position.

RFCs are cached locally at stdpath("cache")/must/ with no expiry (they're pretty small .txt files). The RFC index however DOES have an expiry; once it's more than one day old, it's fetched freshly. Clean the directory out manually if you ever want to get (a very little amount of) disk space back, I might add cache expiry later on.

Installation

lazy.nvim

{
  "undont/must.nvim",
}

vim.pack

vim.pack.add({ "https://github.com/undont/must.nvim" })

mini.deps

MiniDeps.add({
  source = "undont/must.nvim",
})

Configuration

Calling setup is entirely optional, defaults listed here. Feel free to override any of the "keymap" ones with false if you want them disabled.

require("must").setup({
    -- keymaps
    jump_to = "gd",
    toggle_toc = "\\", -- literal backslash
    open_toc_entry = "<CR>",
    toc = {
        split = "right", -- left/right
        width = 55,      -- integer
    },
})