https://github.com/jbyuki/md-prev.nvim

A pure lua markdown previewer for Neovim
https://github.com/jbyuki/md-prev.nvim

lua markdown-previewer neovim neovim-plugin nvim

Last synced: about 1 month ago
JSON representation

A pure lua markdown previewer for Neovim

• Host: GitHub
• URL: https://github.com/jbyuki/md-prev.nvim
• Owner: jbyuki
• License: mit
• Created: 2022-09-25T21:36:54.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-25T23:36:19.000Z (about 2 years ago)
• Last Synced: 2024-08-07T18:35:15.594Z (3 months ago)
• Topics: lua, markdown-previewer, neovim, neovim-plugin, nvim
• Language: Lua
• Homepage:
• Size: 29.3 KB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## md-prev.nvim

A dependency-free plugin to preview markdown in the browser. It relies on the pure markdown-to-html provided by @mpeterv  [here](https://github.com/mpeterv/markdown). Also a big thanks to @realprogrammersusevim for giving me the idea in the first place with his plugin [md-to-html.nvim](https://github.com/realprogrammersusevim/md-to-html.nvim). To make the HTML look more modern, the github's flavored sylesheet is applied to the output available [here](https://github.com/sindresorhus/github-markdown-css). Note that an online connection is required.

Important Note: This an experiment more than anything. It shows what's possible with the Neovim API. It is not planned to develop this much further.

### Usage

* Start server with `require"md-prev".start_server(8087)`.

* Open a browser and navigate to `localhost:8087` and the current buffer will be rendered as HTML.

### Current limitations

* Browser needs to be opened manually

* No way to refresh the page from Neovim. User has to refresh from browser each time to see changes.