{"id":14964386,"url":"https://github.com/josiah-tan/plover-live-view-nvim","last_synced_at":"2026-01-21T00:33:22.652Z","repository":{"id":44842644,"uuid":"450060815","full_name":"Josiah-tan/plover-live-view-nvim","owner":"Josiah-tan","description":"a live viewer for plover within neovim","archived":false,"fork":false,"pushed_at":"2022-01-28T16:02:19.000Z","size":23,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-14T11:02:02.142Z","etag":null,"topics":["neovim","plover","vim"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Josiah-tan.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-20T10:59:35.000Z","updated_at":"2022-01-25T14:22:45.000Z","dependencies_parsed_at":"2022-09-19T03:01:22.083Z","dependency_job_id":null,"html_url":"https://github.com/Josiah-tan/plover-live-view-nvim","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josiah-tan%2Fplover-live-view-nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josiah-tan%2Fplover-live-view-nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josiah-tan%2Fplover-live-view-nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Josiah-tan%2Fplover-live-view-nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Josiah-tan","download_url":"https://codeload.github.com/Josiah-tan/plover-live-view-nvim/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247865861,"owners_count":21009235,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["neovim","plover","vim"],"created_at":"2024-09-24T13:33:06.742Z","updated_at":"2026-01-21T00:33:22.598Z","avatar_url":"https://github.com/Josiah-tan.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"* Plover-live-view-nvim\n- A customizable plugin that allows you to view any file in realtime through nvim\n** Some Use Cases\n- Rabbitgrowth's [[https://github.com/rabbitgrowth/plover-tapey-tape][plover-tapey-tape]] \n\t- Output file (tapey\\under{}tape.txt)\n\t- Alternative to Plover's builtin paper tape\n- tckmn's [[https://github.com/tckmn/plover_clippy][plover-clippy]]\n\t- Output file: clippy.txt\n\t- Alternative to Plover's suggestions, only logs information when a word is stroked inefficiently\n** Installation and dependencies\n- Install like with any other plugin\n- example using vim-plug:\n#+BEGIN_SRC vim\n\" needed for harpoon\nPlug 'nvim-lua/plenary.nvim' \n\" needed for terminal management\nPlug 'ThePrimeagen/harpoon' \nPlug 'Josiah-tan/plover-live-view-nvim'\n#+END_SRC\n** Basic Setup\n#+BEGIN_SRC lua\n-- initializes all defaults\nrequire(\"plover_viewer\").setup({\n\tbuiltin = {\n\t\tcwd = \"path/to/your/config\"\n}})\n-- some possible locations of where config could be depending on OS\n-- cwd = {\"%USERPROFILE%\\AppData\\Local\\plover\", \"~/Library/Application Support/plover\", \"~/.config/plover\"}\n-- Windows: `%USERPROFILE%\\AppData\\Local\\plover`\n-- macOS: `~/Library/Application Support/plover`\n-- Linux: `~/.config/plover`\n\n-- default key bindings (disabled by default)\n-- view clippy.txt in terminal buffer\nvim.keymap.set('n', '\u003cleader\u003epv', function () require(\"plover_viewer.builtin\").view() end)\n-- split the current buffer and view clippy.txt in the terminal (togglable)\nvim.keymap.set('n', '\u003cleader\u003eps', function () require(\"plover_viewer.builtin\").splitToggle() end)\n-- view tapey_tape.txt in terminal\nvim.keymap.set('n', '\u003cleader\u003ept', function () RELOAD(\"plover_viewer.builtin\").splitToggle({\n\tfile_name = \"tapey_tape.txt\",\n\tviewer = {\n\t\tterminal = {\n\t\t\tnumber = 7 -- use a different terminal\n\t\t}\n\t},\n\tsplit = {\n\t\tchoose = \"vertical\"\n\t}\n}) end)\n#+END_SRC\n** Custom Setup \n- Below is the default setup for this plugin \n\t- you only have to override the parts that you want to change\t \n#+BEGIN_SRC lua\nrequire(\"plover_viewer\").setup({\nbuiltin = {\n\tviewer = {\n\t\tchoose = \"terminal\", -- or buf\n\t\tbuf = {\n\t\t},\n\t\tterminal = {\n\t\t\ttype = \"term\", -- or \"tmux\"\n\t\t\tnumber = 6,\n\t\t\tcommand = \"tail\",\n\t\t\targs = {\"-f\"},\n\t\t},\n\t},\n\tsplit = {\n\t\tchoose = \"horizontal\", -- or vertical\n\t\thorizontal = {\n\t\t\tsize = 10,\n\t\t},\n\t\tvertical = {\n\t\t\tsize = nil,\n\t\t}\n\t},\n\tfile_name = \"clippy.txt\",\n\tcwd = nil\n},\ndisable_default_mappings = true\n)}\n#+END_SRC\n*** builtin\n- file\\under{}name = \"clippy.txt\"\n\t- the file to live view\n- cwd = nil\n\t- str: location of config files\n**** viewer\n- choose = \"terminal\"\n\t- \"terminal\": use the terminal for live viewing\n\t- \"buf\": use a vim buffer for live viewing\n- terminal.type = \"term\"\n\t- \"term\": use an neovim terminal\n\t- \"tmux\": use tmux terminal (note that splits for tmux are not supported yet)\n- terminal.number = \"6\"\n\t- number: unique number assigned to a terminal\n- terminal.command = \"tail\"\n\t- str: command to run in the terminal\n- terminal.command\\under{}args = {\"-f\"}\n\t- table[str]: command arguments to run in the terminal\n**** split\n- choose = \"horizontal\"\n\t- \"horizontal\": open split horizontally\n\t- \"vertical\": open split vertically\n- horizontal.size = 10\n\t- height as in the number of rows (only for horizontal split)\n\t- set to nil for a normal split\n- vertical.size = nil\n\t- width as in the number of columns (only for vertical split)\n\t- set to nil for a normal split\n** Custom Mappings\n- you can override the opts given previously to setup() in your keymaps\n\t- for example if you wanted a vertical split instead of horizontal:\n#+BEGIN_SRC lua\nvim.keymap.set('n', '\u003cleader\u003epw', function ()\n\trequire(\"plover_viewer.builtin\").splitToggle({\n\t\tsplit = {\n\t\t\tchoose = \"vertical\"\n\t\t}})\nend)\n#+END_SRC\n** Contributing\n- feel free to raise issues or chuck a pull request if anything is unclear or doesn't work\n\t- I would be happy to receive any feedback\n** Acknowledgements\n- I would like to thank:\n\t- Rabbitgrowth: for telling me about tail -f, without them this plugin would not have been made\n\t - Make sure to checkout their plugin ([[https://github.com/rabbitgrowth/plover-tapey-tape][plover-tapey-tape]]) for a good alternative to Plover's builtin paper tape\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosiah-tan%2Fplover-live-view-nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosiah-tan%2Fplover-live-view-nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosiah-tan%2Fplover-live-view-nvim/lists"}