chore(demo): use vhs and minimal init to record demos

Author: MeanderingProgrammer

README.md

@@ -6,9 +6,9 @@ Plugin to improve viewing Markdown files in Neovim
 
 |           |         |
 | --------- | ------- |
-| ![Heading](https://github.com/user-attachments/assets/663a34c5-0438-4688-8204-332065f65835) | ![Table](https://github.com/user-attachments/assets/162986e1-91f0-4e13-a83f-6183d58b0fcb) |
-| ![Quote](https://github.com/user-attachments/assets/5343ca45-d5e1-4de0-9065-46499e1ed919)   | ![LaTeX](https://github.com/user-attachments/assets/9e8909e4-7256-45fc-b481-4aba8850ebc3) |
-| ![Callout](https://github.com/user-attachments/assets/4324ea72-a017-4175-9f9d-363da5e5f6ba) | |
+| ![Heading](https://github.com/user-attachments/assets/6d5ca2d3-3263-4ccd-beaf-b5795167d776) | ![Table](https://github.com/user-attachments/assets/7c7e6351-baff-4e72-b668-2e4fac76e276) |
+| ![Quote](https://github.com/user-attachments/assets/dba88e99-bff5-4b33-9017-ab55c1058d21)   | ![LaTeX](https://github.com/user-attachments/assets/85bac8f1-c7df-4078-9e9c-374de9b08e03) |
+| ![Callout](https://github.com/user-attachments/assets/bea7e1b9-d77f-4c3f-abf8-f6262b05fad2) | |
 
 <!-- panvimdoc-ignore-end -->
 

demo/format.tape

@@ -0,0 +1,32 @@
+Output OUTPUT
+
+Set FontSize 14
+Set FontFamily "JetBrainsMono Nerd Font"
+Set Width WIDTH
+Set Height HEIGHT
+Set Padding 0
+Set Framerate 60
+Set TypingSpeed 0.1
+
+# Setup
+Hide
+Type "nvim -u demo/minit.lua INPUT" Enter
+Show
+
+Sleep 2s
+
+WRITE
+
+Type "i" Sleep 1s
+Escape Sleep 1s
+
+MOVE
+
+Type "i" Sleep 1s
+Escape Sleep 1s
+
+# Close without editing
+Type ":q!"
+Hide
+Enter
+Sleep 100ms

demo/minit.lua

@@ -0,0 +1,67 @@
+-- Color settings
+vim.opt.termguicolors = true
+vim.opt.cursorline = true
+
+-- Line number settings
+vim.opt.number = true
+vim.opt.relativenumber = true
+vim.opt.statuscolumn = '%s%=%{v:relnum?v:relnum:v:lnum} '
+
+-- Mode is already in status line plugin
+vim.opt.showmode = false
+
+local lazypath = vim.fn.stdpath('data') .. '/lazy/lazy.nvim'
+if not vim.uv.fs_stat(lazypath) then
+    local lazyrepo = 'https://github.com/folke/lazy.nvim.git'
+    vim.fn.system({ 'git', 'clone', '--filter=blob:none', '--branch=stable', lazyrepo, lazypath })
+end
+vim.opt.rtp:prepend(lazypath)
+
+require('lazy').setup({
+    dev = { path = '~/dev/repos/personal' },
+    spec = {
+        {
+            'folke/tokyonight.nvim',
+            config = function()
+                ---@diagnostic disable-next-line: missing-fields
+                require('tokyonight').setup({ style = 'night' })
+                vim.cmd.colorscheme('tokyonight')
+            end,
+        },
+        {
+            'nvim-treesitter/nvim-treesitter',
+            build = ':TSUpdate',
+            config = function()
+                ---@diagnostic disable-next-line: missing-fields
+                require('nvim-treesitter.configs').setup({
+                    ensure_installed = { 'markdown', 'markdown_inline', 'latex' },
+                    highlight = { enable = true },
+                })
+            end,
+        },
+        {
+            'nvim-lualine/lualine.nvim',
+            dependencies = { 'nvim-tree/nvim-web-devicons' },
+            config = function()
+                require('lualine').setup({
+                    sections = {
+                        lualine_a = { 'mode' },
+                        lualine_b = { { 'filename', path = 1 } },
+                        lualine_c = {},
+                        lualine_x = {},
+                        lualine_y = {},
+                        lualine_z = { 'location' },
+                    },
+                })
+            end,
+        },
+        {
+            'MeanderingProgrammer/render-markdown.nvim',
+            dev = true,
+            dependencies = { 'nvim-treesitter/nvim-treesitter', 'echasnovski/mini.nvim' },
+            config = function()
+                require('render-markdown').setup({})
+            end,
+        },
+    },
+})

demo/record.py

@@ -0,0 +1,59 @@
+import subprocess
+from argparse import ArgumentParser
+from pathlib import Path
+
+
+def main(name: str, height: int, content: str):
+    in_file = Path(f"demo/{name}.md")
+    assert in_file.exists()
+
+    out_file = Path(f"demo/{name}.gif")
+    if out_file.exists():
+        out_file.unlink()
+
+    tape = Path("demo/demo.tape")
+    tape.write_text(tape_content(in_file, out_file, height, content))
+    result = subprocess.run(["vhs", tape])
+    assert result.returncode == 0
+    tape.unlink()
+
+
+def tape_content(in_file: Path, out_file: Path, height: int, to_write: str) -> str:
+    content = Path("demo/format.tape").read_text()
+    content = content.replace("INPUT", str(in_file))
+    content = content.replace("OUTPUT", str(out_file))
+    content = content.replace("WIDTH", str(550))
+    content = content.replace("HEIGHT", str(height))
+    content = content.replace("WRITE", get_write(to_write))
+    content = content.replace("MOVE", get_move(in_file))
+    return content
+
+
+def get_write(content: str) -> str:
+    write: list[str] = []
+    if len(content) > 0:
+        write.append('Type "o"')
+        write.append("Enter")
+        write.append(f'Type "{content}" Escape')
+        write.append('Type "0" Sleep 2s')
+    return "\n".join(write)
+
+
+def get_move(in_file: Path) -> str:
+    move: list[str] = []
+    # Get lines so we know how to scroll down, account for starting on first line
+    lines: list[str] = Path(in_file).read_text().splitlines()[1:]
+    for line in lines:
+        skip = ("    ", "def", "if")
+        duration = 0.1 if line == "" or line.startswith(skip) else 0.75
+        move.append(f"Down@{duration}s")
+    return "\n".join(move)
+
+
+if __name__ == "__main__":
+    parser = ArgumentParser(description="Generate a demo recording using vhs")
+    parser.add_argument("--name", type=str, required=True)
+    parser.add_argument("--height", type=int, required=True)
+    parser.add_argument("--content", type=str, required=True)
+    args = parser.parse_args()
+    main(args.name, args.height, args.content)

demo/run.py

@@ -20,31 +20,34 @@ health:
 demo: demo-heading demo-list demo-box demo-latex demo-callout
 
 demo-heading:
-  just demo-file "heading_code" "30" "## Heading 2"
+  python demo/run.py \
+    --name "heading_code" \
+    --height "550" \
+    --content "## Heading 2"
 
 demo-list:
-  just demo-file "list_table" "30" ""
+  python demo/run.py \
+    --name "list_table" \
+    --height "550" \
+    --content ""
 
 demo-box:
-  just demo-file "box_dash_quote" "15" ""
+  python demo/run.py \
+    --name "box_dash_quote" \
+    --height "250" \
+    --content ""
 
 demo-latex:
-  just demo-file "latex" "15" ""
+  python demo/run.py \
+    --name "latex" \
+    --height "250" \
+    --content ""
 
 demo-callout:
-  just demo-file "callout" "40" ""
-
-demo-file file rows content:
-  rm -f demo/{{file}}.gif
-  python demo/record.py \
-    --cols "60" \
-    --rows {{rows}} \
-    --file demo/{{file}}.md \
-    --cast {{file}}.cast \
-    --content "{{content}}"
-  # https://github.com/MeanderingProgrammer/cli/tree/main/agg
-  agg {{file}}.cast demo/{{file}}.gif
-  rm {{file}}.cast
+  python demo/run.py \
+    --name "callout" \
+    --height "750" \
+    --content ""
 
 update:
   # Updates types.lua & README.md