1 files changed, 33 insertions, 0 deletions
diff --git a/yazi/plugins/glow.yazi/README.md b/yazi/plugins/glow.yazi/README.md
new file mode 100644
index 0000000..5e12e0f
--- /dev/null
+++ b/yazi/plugins/glow.yazi/README.md
@@ -0,0 +1,33 @@
+# glow.yazi
+
+>[!WARNING]
+>This plugin is now deprecated with the release of [Piper](https://github.com/yazi-rs/plugins/tree/main/piper.yazi#examples)
+
+Plugin for [Yazi](https://github.com/sxyazi/yazi) to preview markdown files with [glow](https://github.com/charmbracelet/glow). To install, run the below mentioned command:
+
+```bash
+ya pack -a Reledia/glow
+```
+
+then include it in your `yazi.toml` to use:
+
+```toml
+[plugin]
+prepend_previewers = [
+  { name = "*.md", run = "glow" },
+]
+```
+
+Make sure you have [glow](https://github.com/charmbracelet/glow) installed, and can be found in `PATH`.
+
+## Feature
+
++ You can modify line wrap in `main.lua`, the current value is 55.
++ You can press `ctrl+e` to scroll up and `ctrl+y` to scroll down the readme file in preview panel in yazi: (add this to `keymap.toml`)
+```toml
+prepend_keymap = [
+    # glow.yazi
+    { on = ["<C-e>"], run = "seek 5" },
+    { on = ["<C-y>"], run = "seek -5" },
+]
+```