{"id":17058769,"url":"https://github.com/smkent/vim-pipe-preview","last_synced_at":"2025-04-12T17:51:00.602Z","repository":{"id":150156685,"uuid":"64578369","full_name":"smkent/vim-pipe-preview","owner":"smkent","description":"📝 🔍 Pipe a vim buffer through an external command and view the results in a scrollbind split","archived":false,"fork":false,"pushed_at":"2022-08-19T04:46:29.000Z","size":388,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-26T12:11:25.895Z","etag":null,"topics":["screenshot","vim","vim-plugin"],"latest_commit_sha":null,"homepage":"","language":"VimL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smkent.png","metadata":{"files":{"readme":"README.md","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-31T05:24:59.000Z","updated_at":"2023-11-17T16:18:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"e07a8560-175e-45ad-8efa-3380651e46d4","html_url":"https://github.com/smkent/vim-pipe-preview","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/smkent%2Fvim-pipe-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fvim-pipe-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fvim-pipe-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smkent%2Fvim-pipe-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smkent","download_url":"https://codeload.github.com/smkent/vim-pipe-preview/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248610376,"owners_count":21132920,"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":["screenshot","vim","vim-plugin"],"created_at":"2024-10-14T10:30:50.235Z","updated_at":"2025-04-12T17:51:00.597Z","avatar_url":"https://github.com/smkent.png","language":"VimL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vim-pipe-preview\n\nvim-pipe-preview provides a way to pipe a buffer through an external command\nand display the output in a separate split, which scrolls together with the\nsource buffer.\n\nThis plugin can pipe buffer contents through any command that reads from\nstandard input and returns results on standard output. My original motivation\nfor writing this plugin was to preview Markdown files using\n[terminal_markdown_viewer](https://github.com/axiros/terminal_markdown_viewer)\nwithin vim.\n\nThis plugin was developed and tested on Linux.\n\n![](/img/screenshot.png)\n\n## Installation\n\nTo install with [vim-plug](https://github.com/junegunn/vim-plug),\nadd an entry to your `~/.vimrc`:\n\n```vim\nPlug 'smkent/vim-pipe-preview'\n```\n\nRestart vim (or reload your `~/.vimrc`) and run `:PlugInstall`.\n\n## Dependencies\n\nIf [AnsiEsc](https://github.com/vim-scripts/AnsiEsc.vim) is installed, ANSI\ncolor escape codes will be evaluated in the preview window automatically.\n\n## Configuration and Usage\n\nSpecify the external pipe command to be used by setting\n`g:pipe_preview_command`.\n\nFor example, to preview using\n[terminal_markdown_viewer](https://github.com/axiros/terminal_markdown_viewer),\nset the following in your `~/.vimrc`:\n\n```vim\nlet g:pipe_preview_command = 'mdv -'\n```\n\nPreview a buffer with the configured external command by running:\n\n```vim\n:PipePreview\n```\n\nOnce the preview window is active, its contents will be updated automatically\nusing the configured external command each time the parent buffer is saved.\n\nThe `:PipePreview` command may also be mapped for easier use. For example:\n\n```vim\nnnoremap \u003csilent\u003e ,pp :\u003cC-U\u003ePipePreview\u003cCR\u003e\n```\n\nPlease see [the vim-pipe-preview help file](/doc/vim-pipe-preview.txt) for full\ndocumentation.\n\n## Inspiration\n\nThis was partially inspired by\n[vim-fugitive](https://github.com/tpope/vim-fugitive); particularly `:Gblame`\nwhich creates a [`scrollbind`\nwindow](http://vim.wikia.com/wiki/Scrolling_synchronously) with `git blame`\noutput.\n\n## License\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\nSee [`LICENSE`](/LICENSE) for the full license text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmkent%2Fvim-pipe-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmkent%2Fvim-pipe-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmkent%2Fvim-pipe-preview/lists"}