From 847f0dae5d3d1b460bac8c86368897d7fdd729c6 Mon Sep 17 00:00:00 2001
From: Tomas Rivera <tomas.riveral@icloud.com>
Date: Wed, 22 Apr 2026 18:24:35 +0200
Subject: [PATCH] Micro: added initial documentation

---
 README.md     | 18 ++++++++++--------
 docs/micro.md | 28 ++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 8 deletions(-)
 create mode 100644 docs/micro.md

diff --git a/README.md b/README.md
index 4596598..f1c6a88 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,7 @@ You must also have a [supported editor (and their associated plugin if needed)](
 
 * `helix`
 * `kakoune`
+* `micro`
 * `nano`
 * `neovim`
 * `vim`
@@ -141,13 +142,14 @@ The first two features depend on [Vivify's editor integration](https://github.co
 
 If your editor does not support these features, you can implement a plugin using [Vivify's API](https://github.com/jannis-baum/Vivify?tab=readme-ov-file#editor-support).
 
-| Editor    | Bufferless  | Cursor  | Jump to end  | Plugin required                                         |
-| --------- | ----------- | ------- | ------------ | --------------------------------------------------------|
-| Helix     | ❌          | ❌      | ✅           | —                                                       |
-| Kakoune   | ❌          | ❌      | ✅           | —                                                       |
-| Nano      | ❌          | ❌      | ✅           | —                                                       |
-| Neovim    | ✅          | ✅      | ✅           | [vivify-vim](https://github.com/jannis-baum/vivify.vim) |
-| Vim       | ✅          | ✅      | ✅           | [vivify-vim](https://github.com/jannis-baum/vivify.vim) |
+| Editor    | Bufferless  | Cursor  | Jump to end  | Aditional requirements                                   |
+| --------- | ----------- | ------- | ------------ | ---------------------------------------------------------|
+| Helix     | ❌          | ❌      | ✅           | —                                                        |
+| Kakoune   | ❌          | ❌      | ✅           | —                                                        |
+| Micro     | ❌          | ✅      | ✅           | [micro-vivify](https://codeberg.org/gibbert/micro-vivify) and [modifications to your `init.lua`](./docs/micro.md)|
+| Nano      | ❌          | ❌      | ✅           | —                                                        |
+| Neovim    | ✅          | ✅      | ✅           | [vivify-vim](https://github.com/jannis-baum/vivify.vim)  |
+| Vim       | ✅          | ✅      | ✅           | [vivify-vim](https://github.com/jannis-baum/vivify.vim)  |
 
 [How to add support for another editor](./CONTRIBUTING.md#adding-editor-support)
 
@@ -204,5 +206,5 @@ It is recommended to use a browser different from your main one for rendering.
 
 * [ ] A converter between journal types
 * [ ] Support multiple vault directories
-* [ ] Port NoteWrapper to other editors (non-exhaustive list of planned ports: `emacs -nw`, `micro`, `jed`, `ad`, flow-control, `ee`, `amp`, `dte`, `cano`, `mle`, `zee`, `ptext`, `kibi`, `ox`, `ne`, `nvi`, `dit`, `zile`, `moe`, `joe`)
+* [ ] Port NoteWrapper to other editors (non-exhaustive list of planned ports: `emacs -nw`, `jed`, `ad`, flow-control, `ee`, `amp`, `dte`, `cano`, `mle`, `zee`, `ptext`, `kibi`, `ox`, `ne`, `nvi`, `dit`, `zile`, `moe`, `joe`)
 * [ ] Default to $EDITOR
diff --git a/docs/micro.md b/docs/micro.md
new file mode 100644
index 0000000..5235a80
--- /dev/null
+++ b/docs/micro.md
@@ -0,0 +1,28 @@
+You must add the following code to your `init.lua`:
+
+```lua
+local buffer = import("micro/buffer")
+local shell = import("micro/shell")
+
+function vivifyOpen(buf)
+    local cursor = buf:GetActiveCursor()
+    local line = cursor.Loc.Y + 1
+
+    shell.ExecCommand("viv", string.format("%s:%d", buf.AbsPath, line))
+end
+
+function onBufferOpen(buf)
+    if os.getenv("MICRO_VIVIFY") ~= "1" then
+        return
+    end
+
+    if buf.Type.Kind == buffer.BTDefault then
+        vivifyOpen(buf)
+    end
+end
+```
+
+This enables Vivify to run automatically when a file is opened, effectively simulating “startup” behavior (since Micro does not provide a true startup command hook for this use case).
+
+Big thanks to @Andriamanitra for answering [my questions](https://github.com/micro-editor/micro/discussions/4078).
+