{"id":13503351,"url":"https://github.com/instant-markdown/vim-instant-markdown","last_synced_at":"2025-05-15T02:09:26.201Z","repository":{"id":2438778,"uuid":"3408646","full_name":"instant-markdown/vim-instant-markdown","owner":"instant-markdown","description":"Instant Markdown previews from Vim","archived":false,"fork":false,"pushed_at":"2023-11-06T07:20:43.000Z","size":154,"stargazers_count":2736,"open_issues_count":4,"forks_count":250,"subscribers_count":44,"default_branch":"master","last_synced_at":"2025-05-06T21:43:23.245Z","etag":null,"topics":["markdown","vim"],"latest_commit_sha":null,"homepage":"https://instant-markdown.github.io","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/instant-markdown.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"AUTHORS.md"},"funding":{"open_collective":"instant-markdown"}},"created_at":"2012-02-10T16:13:25.000Z","updated_at":"2025-05-04T06:50:16.000Z","dependencies_parsed_at":"2023-12-16T09:04:35.983Z","dependency_job_id":"8d8836b6-48c8-4ff0-9f89-a9cb115245de","html_url":"https://github.com/instant-markdown/vim-instant-markdown","commit_stats":{"total_commits":133,"total_committers":28,"mean_commits":4.75,"dds":0.736842105263158,"last_synced_commit":"2913d5fd8357bd5f57de842f01d914bd35fe7b14"},"previous_names":["suan/vim-instant-markdown"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instant-markdown%2Fvim-instant-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instant-markdown%2Fvim-instant-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instant-markdown%2Fvim-instant-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instant-markdown%2Fvim-instant-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instant-markdown","download_url":"https://codeload.github.com/instant-markdown/vim-instant-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259384,"owners_count":22040820,"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","vim"],"created_at":"2024-07-31T22:02:47.952Z","updated_at":"2025-05-15T02:09:26.178Z","avatar_url":"https://github.com/instant-markdown.png","language":"Vim Script","funding_links":["https://opencollective.com/instant-markdown","https://opencollective.com/instant-markdown/"],"categories":["Vim Script","Vim script","vim"],"sub_categories":[],"readme":"vim-instant-markdown\n====================\n\n[![open collective badge](https://opencollective.com/instant-markdown/tiers/backer/badge.svg?label=backer\u0026color=brightgreen)](https://opencollective.com/instant-markdown/)\n\nWant to instantly preview finicky markdown files, but don't want to leave your\nfavourite editor, or have to do it in some crappy browser text area?\n**vim-instant-markdown** is your friend! When you open a markdown file in Vim,\na browser window will open which shows the compiled markdown in real-time, and\ncloses once you close the file in Vim.\n\nAs a bonus, [github-flavored-markdown][gfm] is supported, and styles used while\npreviewing are the same as those GitHub uses!\n\n[![Screenshot][ss]][ssbig]\n\nInstallation\n------------\n**Quick start** (assuming you have all the necessary dependencies):\n\n- Install the Node.js mini-server by running either:\n\n  - `[sudo] npm -g install instant-markdown-d` or, for the pre-release version:\n  - `[sudo] npm -g install instant-markdown-d@next`\n\n  or the following command for the Python mini-server (which also requires\n  [pandoc][pandoc] to render markdown):\n\n  - `pip install --user smdv`\n\n* Add the following to your `.vimrc`, depending on the plugin manager of your\n  choice:\n\n  - [vim-plug][plug]\n\n    ```vim\n    Plug 'instant-markdown/vim-instant-markdown', {'for': 'markdown', 'do': 'yarn install'}\n    ```\n\n  - [Vundle][vundle]\n\n    ```vim\n    Plugin 'instant-markdown/vim-instant-markdown'\n    ```\n  - Vim8 built-in package manager (Execute the following command instead of adding it to `.vimrc`)\n\n\t```shell\n    # NOTE:\n    # 1. Please check you have git installed.\n    # 2. Please replace * with a package name you want.\n    git clone https://github.com/instant-markdown/vim-instant-markdown.git ~/.vim/pack/*/start/\n\t```\n\n**Detailed instructions**\n\n- If you're on Linux, ensure the following packages are installed:\n  - `xdg-utils`\n  - `curl`\n  - `nodejs` (Ensure that you are using a recent stable version. [Install `node` using `n` if needed][n].)\n- If you're on Windows, you will need into install [cURL][curl] and put it on your `%PATH%`.\n- If you do not use a plugin manager, copy the\n  [`ftplugin/markdown/instant-markdown.vim`](ftplugin/markdown/instant-markdown.vim)\n  file into `~/.vim/ftplugin/markdown/` (creating directories as\n  necessary),\n- Open a markdown file in Vim and enjoy!\n\n**Arch-based distributions**\n- There is a package available on the AUR that installs the plugin:\n    - [vim-instant-markdown](https://aur.archlinux.org/packages/vim-instant-markdown)\n\nConfiguration\n-------------\n\nMinimal default configuration:\n\n```vim\nfiletype plugin on\n\"Uncomment to override defaults:\n\"let g:instant_markdown_slow = 1\n\"let g:instant_markdown_autostart = 0\n\"let g:instant_markdown_open_to_the_world = 1\n\"let g:instant_markdown_allow_unsafe_content = 1\n\"let g:instant_markdown_allow_external_content = 0\n\"let g:instant_markdown_mathjax = 1\n\"let g:instant_markdown_mermaid = 1\n\"let g:instant_markdown_logfile = '/tmp/instant_markdown.log'\n\"let g:instant_markdown_autoscroll = 0\n\"let g:instant_markdown_port = 8888\n\"let g:instant_markdown_python = 1\n\"let g:instant_markdown_theme = 'dark'\n```\n\nAfter installing the plugin, execute [`:help vim-instant-markdown-configuration`](./doc/vim-instant-markdown.txt)\nto read more about what the different configuration options imply.\n\n\nSupported Platforms\n-------------------\n\nOSX, Linux^, and Windows^^.\n\n\u003csub\u003e^ One annoyance in Linux is that there's no way to reliably open a\nbrowser page in the background, so you'll likely have to manually refocus your\nVim session every time you open a Markdown file. If you have ideas on how to\naddress this I'd love to know!\u003c/sub\u003e\n\n\u003csub\u003e^^ In Windows, there's no easy way to execute commands asynchronously\nwithout popping up a cmd.exe window. Thus, if you run this plugin without\n`g:instant_markdown_slow`, you might experience performance issues.\u003c/sub\u003e\n\nFAQ\n---\n1. It's not working!\n\n   - Make sure `instant-markdown-d` was installed and verify using\n  `InstantMarkdownDPath`.\n   - Try to launch with Vim and [vim-plug][plug] and this\n  [minimal.vimrc](https://raw.githubusercontent.com/instant-markdown/vim-instant-markdown/master/doc/minimal.vimrc)\n  as `vim -u vim -u minimal.vimrc my_markdown_file.md`\n   - If you're on OSX and are using zsh, try to add `set shell=bash\\ -i` in your\n  `.vimrc` to set interactive bash as the default Vim shell. (See [this\n  issue](http://github.com/instant-markdown/vim-instant-markdown/issues/41))\n\n2. How to start it when autostart is off?\n\n   You can use the command `:InstantMarkdownPreview` to manually start the preview. \u003cbr\u003e\n   BTW, to disable it, use `:InstantMarkdownStop`.\n\n_If you're curious, the code for the mini-server component for this plugin can\nbe found at http://github.com/instant-markdown/instant-markdown-d. A plugin can\neasily be written for any editor to interface with the server to get the same\nfunctionality found here._\n\n\n[ss]: https://i.imgur.com/r7G6FNA.gif \"Click for bigger preview\"\n[ssbig]: https://i.imgur.com/4Fty7pw.gif\n[n]: https://github.com/tj/n\n[gfm]: http://github.github.com/github-flavored-markdown/\n[curl]: http://curl.haxx.se/download.html\n[tpope-markdown]: https://github.com/tpope/vim-markdown\n[plug]: https://github.com/junegunn/vim-plug\n[vundle]: https://github.com/gmarik/Vundle.vim\n[pandoc]: https://pandoc.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstant-markdown%2Fvim-instant-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstant-markdown%2Fvim-instant-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstant-markdown%2Fvim-instant-markdown/lists"}