Skip to content

san-siva/blogkit-md.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

name blogkit-md.nvim
description A Neovim plugin that launches a live preview of the current markdown buffer using @san-siva/blogkit-md-cli

blogkit-md.nvim

A Neovim plugin that launches a live preview of the current markdown buffer using @san-siva/blogkit-md-cli.

demo.mov

Requirements

Requirement Version
Neovim 0.9+
Node.js LTS
blogkit-md-cli latest

Getting started

lazy.nvim

{
  'san-siva/blogkit-md.nvim',
}

packer.nvim

use { 'san-siva/blogkit-md.nvim' }

Commands

Command Description
:BlogkitPreview Start a live preview of the current buffer
:BlogkitPreviewStop Stop the preview for the current buffer
:BlogkitPreviewStopAll Stop all running previews

Usage

  1. Open a markdown file in Neovim.
  2. Run :BlogkitPreview — the browser opens automatically.
  3. Edit and save the file; the browser reloads on every write.
  4. Run :BlogkitPreviewStop when done, or :BlogkitPreviewStopAll to stop all running previews.

How it works

The plugin invokes the blogkit-md CLI with the current buffer's file path. The CLI starts a pre-built Next.js server, opens the browser, and watches the file for changes — reloading the browser automatically on every save via SSE.

License

MIT

About

About

Neovim plugin for live markdown preview using blogkit-md

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages