https://github.com/rogue-87/inlyne.nvim

Wrapper for inlyne markdown viewer
https://github.com/rogue-87/inlyne.nvim

lua neovim neovim-plugin

Last synced: about 2 months ago
JSON representation

Wrapper for inlyne markdown viewer

• Host: GitHub
• URL: https://github.com/rogue-87/inlyne.nvim
• Owner: rogue-87
• License: apache-2.0
• Created: 2025-07-24T16:32:36.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2026-02-01T17:50:37.000Z (2 months ago)
• Last Synced: 2026-02-02T01:31:25.744Z (2 months ago)
• Topics: lua, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 49.8 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

• awesome-neovim-sorted - rogue-87/inlyne.nvim
• awesome-neovim - rogue-87/inlyne.nvim - Wrapper for [inlyne](https://github.com/Inlyne-Project/inlyne) Markdown viewer. (Programming Languages Support / Markdown and LaTeX)

README

          
# 📓 Inlyne.nvim

![Neovim](https://img.shields.io/badge/Neovim-0.11+-green.svg?style=flat&logo=neovim)

![License](https://img.shields.io/badge/License-MIT-blue.svg)

inlyne.nvim is a simple neovim plugin wrapper around the [inlyne](https://github.com/Inlyne-Project/inlyne) markdown viewer tool.

https://github.com/user-attachments/assets/35738769-763b-4def-b87f-dc100ea1f65e

## ❗ Requirements

- Neovim >= 0.11

- inlyne installed (`cargo install inlyne` or [pre-built binary](https://github.com/Inlyne-Project/inlyne/releases) )

## 📦 Installation

Install the plugin with your package manager of choice

[lazy.nvim](https://github.com/folke/lazy.nvim)

```lua

{

    "rogue-87/inlyne.nvim",

    -- some optional keymaps

    --[[ keys = {

        { "ie", "Inlyne enable", desc = "Enable Inlyne" },

        { "id", "Inlyne disable", desc = "Disable Inlyne" },

        { "it", "Inlyne toggle", desc = "Toggle Inlyne" },

    }, ]]

    opts = {},

}

```

## Configuration

> [!important]

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

```lua

---@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