📜 Markview.nvim

Simple markdown previewer for neovim

Warning

This plugin is in it's alpha stage and may go through breaking changes.

Caution

If you are using presets then you should stop using them. Presets are going to get reworked in the coming updates so to prevent things from accidentally breaking please refrain for using them.

Important

Highlights now use PascalCase so it is recommended to change your highlight group names to PascalCase. But don't worry, the previous names using Markview_ are still supported!

📑 Table of contents

• Features
• Requirements
• Installation
  • Lazy.nvim
  • Mini.deps
  • Others
• Setup
• Commands
• Showcases

🛸 Features

• Fully customisable markdown headings.
• Custom block quotes with support for callouts & alerts.
• Custom code blocks with different style supports.
• Statusline-like horizontal rules customisation.
• Custom links and image links.
• Custom inline codes.
• Padded list items(with nested list support).
• Custom checkboxes for different checkbox states.
• Fully customisable tables.

🔭 Requirements

• Neovim version: 0.10 or higher(unless API changes occurred).
• nvim-treesitter for easy installation of treesitter parsers.
• markdown and markdown_inline treesitter parsers.
• nvim-web-devicons for the icons.

📦 Installation

💤 Lazy.nvim

For plugins.lua or lazy.lua users.

{
    "OXY2DEV/markview.nvim",
    ft = "markdown",

    dependencies = {
        -- You may not need this if you don't lazy load
        -- Or if the parsers are in your $RUNTIMEPATH
        "nvim-treesitter/nvim-treesitter",

        "nvim-tree/nvim-web-devicons"
    },
}

For plugins/markview.lua users

return {
    "OXY2DEV/markview.nvim",
    ft = "markdown",

    dependencies = {
        -- You may not need this if you don't lazy load
        -- Or if the parsers are in your $RUNTIMEPATH
        "nvim-treesitter/nvim-treesitter",

        "nvim-tree/nvim-web-devicons"
    },
}

🦠 Mini.deps

local MiniDeps = require("mini.deps");

MiniDeps.add({
    source = "OXY2DEV/markview.nvim",

    depends = {
        -- You may not need this if you don't lazy load
        -- Or if the parsers are in your $RUNTIMEPATH
        "nvim-treesitter/nvim-treesitter",

        "nvim-tree/nvim-web-devicons"
    }
})

🤔 Others

The installation process for any other plugin manager(s) is the same.

If your plugin manager doesn't support dependencies then you can always load the plugins in the right order.

Plug "nvim-treesitter/nvim-treesitter"
Plug "nvim-tree/nvim-web-devicons"

Plug "OXY2DEV/markview.nvim"

🧭 Setup

Note

This plugin does not use setup() to initialize. So, it is completely optional to call it.

Configuration table for the setup() function is given below.

require("markview").setup({
    buf_ignore = { "nofile" },
    modes = { "n", "no" },

    options = {
        on_enable = {},
        on_disable = {}
    },

    block_quotes = {},
    checkboxes = {},
    code_blocks = {},
    headings = {},
    horizontal_rules = {},
    inline_codes = {},
    links = {},
    list_items = {},
    tables = {}
});

For customisation related options check the wiki pages.

🎹 Commands

Note

Commands are a test feature.

There is only a single command for now, :Markview.

When called without any arguments, it toggles the plugin.

Possible subcommands are,

• toggleAll, toggles the plugin
• enableAll, enables the plugin
• disableAll, disables the plugin
• toggle, toggles the plugin for the specified buffer(default is the current buffer)
• enable, enables the plugin for the specified buffer(default is the current buffer)
• disable, disables the plugin for the specified buffer(default is the current buffer)

👾 Showcases

Important

Screenshots on a phone are very blurry(Yes, the plugin was made on my phone).

If you have screenshots of the plugin, you can submit them in the special issue. And yes, credit will be provided.

_{Taken by @scottmckendry}