https://github.com/samisuleiman/murk.nvim
Neovim plugin to preview markdown files in your browser.
https://github.com/samisuleiman/murk.nvim
lua neovim neovim-lua neovim-plugin
Last synced: 7 months ago
JSON representation
Neovim plugin to preview markdown files in your browser.
- Host: GitHub
- URL: https://github.com/samisuleiman/murk.nvim
- Owner: SamiSuleiman
- License: mit
- Created: 2025-03-02T22:10:57.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-07-18T11:36:40.000Z (7 months ago)
- Last Synced: 2025-07-25T19:34:46.412Z (7 months ago)
- Topics: lua, neovim, neovim-lua, neovim-plugin
- Language: Lua
- Homepage:
- Size: 467 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 `murk.nvim`
Neovim plugin to preview markdown files in your browser:
- Easily preview markdown files in your browser
- Supports custom styling for the preview by providing a CSS file
## ⚡️ Requirements
- Neovim >= 0.7.0
- Pandoc
## 📦 Installation
Using [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
"AntennaTower/murk.nvim",
opts = {},
}
```
## ⚙️ Configuration
**murk.nvim** uses a default configuration, you can override the following options:
Default configuration:
```lua
{
css = "/path/to/style.css",
}
```
## 📃 Usage
| Command | Description |
| ------- | ----------- |
| `:MurkStart` | Adds the current file to the list of watched files |
| `:MurkStop` | Stops watching the current file |
| `:MurkStopAll` | Stops watching all files |
| `:MurkOpen` | Opens the preview of the current file (if it's watched)|