Skip to content

A Neovim plugin for rendering markdown files in terminal

License

Notifications You must be signed in to change notification settings

yelog/marklive.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 marklive.nvim

A Neovim plugin for rendering markdown files in terminal marklive nvim

✨ Features

  • 💡 Any element (treesitter, regex_group) can be replaced with icons
  • 💪 Built-in markdown elements config, markdown files work out of the box
  • 💞 Built-in commands MarkliveEnable, MarkliveDisable, MarkliveToggle to enable/disable/toggle the marklive feature
  • 🛴 Supports automatically disabling the marklive feature on the current line for easy editing
  • 🔎 Highly configurable, allowing custom icons for each markdown element, and even custom displays for html files

⚡️ Requirements

📦 Installation

Using lazy.nvim

{
    "yelog/marklive.nvim",
    dependencies = { 'nvim-treesitter/nvim-treesitter' },
    lazy = true,
    ft = "markdown",
    opts = {}
}

Using packer.nvim

use {
  'yelog/marklive.nvim',
  requires = { 'nvim-treesitter/nvim-treesitter' },
}

Using dein

call dein#add('nvim-treesitter/nvim-treesitter')
call dein#add('yelog/marklive.nvim')

Usingn vim-plug

Plug 'nvim-treesitter/nvim-treesitter'
Plug 'yelog/marklive.nvim'

⚙️ Configuration

The default configuration for marklive.nvim is shown in the link config.lua

If you don't want to use a Nerd Font, you can replace the icons with Unicode symbols.

📝 Plan

  • Implement background style rendering for Markdown’sBlock Quote
  • Implement style rendering for Markdown’sCode Block

🔑 License

marklive.nvim is licensed under the Apache 2.0 license

About

A Neovim plugin for rendering markdown files in terminal

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages