{
    'brianhuster/live-preview.nvim',
    dependencies = {
        -- You can choose one of the following pickers
        'nvim-telescope/telescope.nvim',
        'ibhagwan/fzf-lua',
        'echasnovski/mini.pick',
		'folke/snacks.nvim',
    },
}

MiniDeps.add({
    source = 'brianhuster/live-preview.nvim',
    depends = { 
        -- You can choose one of the following pickers
        'nvim-telescope/telescope.nvim',
        'ibhagwan/fzf-lua',
        'echasnovski/mini.pick',
		'folke/snacks.nvim',
    }, 
})

:Rocks install live-preview.nvim

Plug 'brianhuster/live-preview.nvim'

" You can choose one of the following pickers
Plug 'nvim-telescope/telescope.nvim'
Plug 'ibhagwan/fzf-lua'
Plug 'echasnovski/mini.pick'
Plug 'folke/snacks.nvim'

git clone --depth 1 https://github.com/brianhuster/live-preview.nvim ~/.local/share/nvim/site/pack/brianhuster/start/live-preview.nvim
nvim -c 'helptags ~/.local/share/nvim/site/pack/brianhuster/start/live-preview.nvim/doc' -c 'q'

You may need to run helptags ALL in Neovim to generate the help tags, if your plugin manager does not do it for you.

Note for HTML

This plugin supports live-previewing Markdown, AsciiDoc and SVG files without the need to save the file. However, for HTML files, the preview will only be updated when you save the file.

You can create an autocmd that auto save the file when you leave insert mode.

--- Lua
vim.o.autowriteall = true
vim.api.nvim_create_autocmd({ 'InsertLeavePre', 'TextChanged', 'TextChangedP' }, {
    pattern = '*', callback = function()
        vim.cmd('silent! write')
    end
})

" Vimscript
set autowriteall
autocmd InsertLeavePre,TextChanged,TextChangedP * silent! write

Configuration, usage, FAQ

You can configure this plugin by passing a table to the Lua function

require('livepreview.config').set()

See :h livepreview for all configurations options, as well as usage and FAQ.

Contributing :handshake:

Since this is a young project, there should be a lot of rooms for improvements. If you would like to contribute to this project, please feel free to open an issue or a pull request.

Roadmap :rocket:

See TODO

Acknowledgements 🙏

• Live Server and Live Preview for the idea inspiration
• glacambre/firenvim for the sha1 function reference
• sindresorhus/github-markdown-css CSS style for Markdown files
• markdown-it/markdown-it for parsing Markdown files
• asciidoctor/asciidoctor.js for parsing AsciiDoc files
• KaTeX for rendering math equations
• mermaid-js/mermaid for rendering diagrams
• digitalmoksha/markdown-it-inject-linenumbers : A markdown-it plugin for injecting line numbers into html output

Buy me a coffee ☕

Maintaining this project takes time and effort, especially as I am a student now. If you find this project helpful, please consider supporting me :>

Alternatives

See Wiki for alternatives to live-preview.nvim