{"id":13468987,"url":"https://github.com/euclio/vim-markdown-composer","last_synced_at":"2025-04-04T10:09:33.915Z","repository":{"id":35542178,"uuid":"39813547","full_name":"euclio/vim-markdown-composer","owner":"euclio","description":"An asynchronous markdown preview plugin for Vim and Neovim.","archived":false,"fork":false,"pushed_at":"2024-02-28T06:44:24.000Z","size":212,"stargazers_count":625,"open_issues_count":33,"forks_count":26,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-10-12T18:48:02.076Z","etag":null,"topics":["markdown","neovim","neovim-plugin","rust","vim","vim-plugin"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/euclio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2015-07-28T04:45:03.000Z","updated_at":"2024-09-28T15:49:32.000Z","dependencies_parsed_at":"2024-10-25T18:28:52.317Z","dependency_job_id":"03565e1a-8616-4013-8191-4cd6acb5c2a2","html_url":"https://github.com/euclio/vim-markdown-composer","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/euclio%2Fvim-markdown-composer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euclio%2Fvim-markdown-composer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euclio%2Fvim-markdown-composer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/euclio%2Fvim-markdown-composer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/euclio","download_url":"https://codeload.github.com/euclio/vim-markdown-composer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157283,"owners_count":20893220,"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":["markdown","neovim","neovim-plugin","rust","vim","vim-plugin"],"created_at":"2024-07-31T15:01:23.604Z","updated_at":"2025-04-04T10:09:33.892Z","avatar_url":"https://github.com/euclio.png","language":"Rust","readme":"# vim-markdown-composer\n\n![](https://github.com/euclio/vim-markdown-composer/workflows/Continuous%20integration/badge.svg)\n\nvim-markdown-composer is a plugin that adds asynchronous Markdown preview to\n[Neovim] and [Vim].\n\n![](https://i.imgur.com/ZtyjjRD.gif)\n\nBy default, vim-markdown-composer uses a blazing-fast CommonMark (and\nGitHub)-compliant renderer. However, it can be configured to use any external\nprogram for rendering, such as `pandoc`.\n\n## Requirements\n\nThis plugin requires Neovim or Vim 8. If you are using an OS with Vim\npre-installed, the system Vim might be too old (see `vim --version`).\n\nThis plugin supports Windows, macOS, and Linux.\n\nIn addition to Neovim or Vim, vim-markdown-composer requires a distribution of\n[Rust] with `cargo`. Check out the [Rust installation guide].\n\nvim-markdown-composer officially targets the latest version of [stable Rust].\n\n## Installation\n\nUse whatever plugin manager you like. If you aren't familiar with plugin\nmanagers, I recommend [vim-plug].\n\n### vim-plug\n\nHere's an example of managing installation with vim-plug:\n\n```vim\nfunction! BuildComposer(info)\n  if a:info.status != 'unchanged' || a:info.force\n    if has('nvim')\n      !cargo build --release --locked\n    else\n      !cargo build --release --locked --no-default-features --features json-rpc\n    endif\n  endif\nendfunction\n\nPlug 'euclio/vim-markdown-composer', { 'do': function('BuildComposer') }\n```\n\n### Vundle\n\nIn your `.vimrc`:\n\n```vim\nPlugin 'euclio/vim-markdown-composer'\n```\n\nOnce you have installed the plugin, close Vim/Neovim then (on Linux):\n\n```sh\n$ cd ~/.vim/bundle/vim-markdown-composer/\n# Vim\n$ cargo build --release --no-default-features --features json-rpc\n# Neovim\n$ cargo build --release\n```\n\n### Dein.vim\n\n```\ncall dein#add('euclio/vim-markdown-composer', { 'build': 'cargo build --release' })\n```\n\n### Other plugin managers\n\nYou should run `cargo build --release` in the plugin directory after\ninstallation. Vim support requires the `json-rpc` cargo feature.\n\nIf you use the above snippet, everything should be taken care of automatically.\n\n## Plugin Options\n\nBy default, `vim-markdown-composer` will open a new browser tab with the rendered preview. This can be prevented by setting the following in your Vim configuration:\n\n```\nlet g:markdown_composer_autostart = 0\n```\n\n## Documentation\n\n`:help markdown-composer`, or check out the `doc` directory.\n\n## Acknowledgments\n\nThis plugin is inspired by suan's [vim-instant-markdown].\n\nThis plugin was built with [aurelius], a Rust library for live-updating Markdown\npreviews.\n\n[Rust]: http://www.rust-lang.org/\n[cargo]: https://crates.io/\n[Neovim]: https://neovim.io/\n[Vim]: http://www.vim.org\n[vim-instant-markdown]: https://github.com/suan/vim-instant-markdown\n[Neovim remote plugin]: https://neovim.io/doc/user/remote_plugin.html\n[vim-plug]: https://github.com/junegunn/vim-plug\n[msgpack-rpc]: https://github.com/msgpack-rpc/msgpack-rpc\n[aurelius]: https://github.com/euclio/aurelius\n[stable Rust]: https://www.rust-lang.org/downloads.html\n[Rust installation guide]: https://www.rust-lang.org/en-US/install.html\n","funding_links":[],"categories":["Rust"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuclio%2Fvim-markdown-composer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feuclio%2Fvim-markdown-composer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feuclio%2Fvim-markdown-composer/lists"}