📓 Inlyne.nvim

inlyne.nvim is a simple neovim plugin wrapper around the inlyne markdown viewer tool.

showcase.mov

❗ Requirements

• Neovim >= 0.11
• inlyne installed (cargo install inlyne or pre-built binary )

📦 Installation

Install the plugin with your package manager of choice

lazy.nvim

{
    "rogue-87/inlyne.nvim",
    -- some optional keymaps
    --[[ keys = {
        { "<leader>ie", "<cmd>Inlyne enable<cr>", desc = "Enable Inlyne" },
        { "<leader>id", "<cmd>Inlyne disable<cr>", desc = "Disable Inlyne" },
        { "<leader>it", "<cmd>Inlyne toggle<cr>", desc = "Toggle Inlyne" },
    }, ]]
    opts = {},
}

Configuration

Important

Make sure to run :checkhealth inlyne if something isn't working properly

---@class Inlyne.Config
---@field bin string
---@field debounce_ms integer
local default_config = {
    bin = "inlyne", -- must be available in PATH
    debounce_ms = 200, -- delay in milliseconds for live preview updates
}

Usage

Inlyne enable : starts inlyne

Inlyne disable : stops inlyne

Inlyne toggle: toggles inlyne