Easily render markdown files in neovim
- Quickly render a markdown file to a browser
- Render other file types that are supported by Vivify
- Optional integration with Mason
| Package manager | Snippet |
|---|---|
-- stable version
use {"neovim-vivify-markdown.nvim", tag = "stable" }
-- dev version
use {"neovim-vivify-markdown.nvim"} |
|
-- stable version
Plug "neovim-vivify-markdown.nvim", { "tag": "stable" }
-- dev version
Plug "neovim-vivify-markdown.nvim" |
|
-- stable version
require("lazy").setup({{"neovim-vivify-markdown.nvim", version = "stable"}})
-- dev version
require("lazy").setup({"neovim-vivify-markdown.nvim"}) |
This is a simple plugin for neovim to integrate the extremely capable Vivify markdown renderer seamlessly in your NeoVim config. This allows you to use a single keystroke to create a live rendering of the markdown file.
The plugin can be installed by using the desired plugin manager as shown in Installation. The plugin comes with a set of default keybindings that can be used by default without configuration. Otherwise, all configuration options are given below.
The configuration list sometimes become cumbersome, making it folded by default reduce the noise of the README file.
Click to unfold the full list of options with their default values
Note: The options are also available in neovim by calling
:h neovim-vivify-markdown.options
require("neovim-vivify-markdown").setup({
-- you can copy the full list from lua/neovim-vivify-markdown/config.lua
})| Command | Description |
|---|---|
:Toggle |
Enables the plugin. |
We welcome all contributions. Please look at CONTRIBUTING to see more information about how to contribute to the project.
This project is heavily inspired by the neovim plugin by https://github.com/iamcco/markdown-preview.nvim and https://github.com/jannis-baum/vivify.vim. Of course, it would not exist without Vivify.
This project is licensed under the MIT License. Some ancillary files are licensed under the Creative Commons Zero and are dedicated to the Public Domain.