extra-instant-markdown : Instant Markdown previews from VIM!
| script karma |
Rating 0/0,
Downloaded by 731 |
Comments, bugs, improvements
|
Vim wiki
|
| created by |
| Chu Khaidi |
| |
| script type |
| utility |
| |
| description |
https://github.com/NBUT-Developers/extra-instant-markdown
extra-instant-markdown is a fork of vim-instant-markdown.
Want to instantly preview finnicky markdown files, but don't want to leave your favorite editor, or have to do it in some crappy browser textarea? vim-instant-markdown is your friend! When you open a markdown file in vim, a browser window will open which shows the compiled markdown in real-time, and closes once you close the file in vim.
As a bonus, github-flavored-markdown is supported, and styles used while previewing are the same as those github uses! |
| |
| install details |
Installation
You first need to have node.js with npm installed.
[sudo] npm -g install instant-markdown-x
If you're on Linux, the xdg-utils package needs to be installed (is installed by default on Ubuntu).
Using Vundle and add NBUT-Developers/extra-instant-markdown.
Open a markdown file in vim and enjoy!
Configuration
g:instant_markdown_slow
By default, extra-instant-markdown will update the display in realtime. If that taxes your system too much, you can specify
let g:instant_markdown_slow = 1
before loading the plugin (for example place that in your ~/.vimrc). This will cause extra-instant-markdown to only refresh on the following events:
No keys have been pressed for a while
A while after you leave insert mode
You save the file being edited
g:instant_markdown_autostart
By default, extra-instant-markdown will automatically launch the preview window when you open a markdown file. If you want to manually control this behavior, you can specify
let g:instant_markdown_autostart = 0
in your .vimrc. You can then manually trigger preview via the command :InstantMarkdownPreview. This command is only available inside markdown buffers and when the autostart option is turned off.
Supported Platforms
OSX and Unix/Linuxes*.
*: One annoyance in Linux is that there's no way to reliably open a browser page in the background, so you'll likely have to manually refocus your vim session everytime you open a Markdown file. If you have ideas on how to address this I'd love to know!
FAQ
Why don't my <bla>.md files trigger this plugin?
By default, vim (7.3 and above) only recognizes files ending with .markdown, .mdown, and README.md as markdown files. If you want <anything>.md to be recognized, I recommend installing one of many markdown plugins available, such as this one.
It's not working!
Make sure instant-markdown-x was installed as a global module (e.g. using npm -g install)
If you're on OSX and are using zsh, try to add set shell=bash\ -i in your .vimrc to set interactive bash as the default vim shell. (See this issue)
etc.
If you're curious, the code for the mini-server component for this plugin can be found at http://github.com/suan/instant-markdown-d. A plugin can easily be written for any editor to interface with the server to get the same functionality found here. |
| |
script versions (upload new version)
Click on the package to download.
ip used for rating: 18.216.94.152
|
