Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamcco/markdown-preview.vim
⚠️ PLEASE USE https://github.com/iamcco/markdown-preview.nvim INSTEAD
https://github.com/iamcco/markdown-preview.vim
markdown markdownpreview mathjax mathjaxpreview neovim plugin vim
Last synced: 10 days ago
JSON representation
⚠️ PLEASE USE https://github.com/iamcco/markdown-preview.nvim INSTEAD
- Host: GitHub
- URL: https://github.com/iamcco/markdown-preview.vim
- Owner: iamcco
- Archived: true
- Created: 2015-09-21T02:20:20.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-08T11:01:29.000Z (over 5 years ago)
- Last Synced: 2024-07-31T22:43:41.067Z (3 months ago)
- Topics: markdown, markdownpreview, mathjax, mathjaxpreview, neovim, plugin, vim
- Language: CSS
- Homepage:
- Size: 4.71 MB
- Stars: 792
- Watchers: 30
- Forks: 75
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction
[](https://gitter.im/iamcco/markdown-preview.vim?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[中文](./README_cn.md)
Using the markdown-preview.vim plugin, you can preview Markdown in real-time
with a web browser.
> This plugin needs your Vim to support Python 2 / Python 3 features.
> Tested on Windows / Ubuntu 14 / Mac OS X.
**Note:** PLEASE USE [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) INSTEAD
### Screenshots
**Markdown preview**
**Typeset math**
### Installation
With [vim-plug](https://github.com/junegunn/vim-plug):
Add `Plug 'iamcco/markdown-preview.vim'` to the `vimrc` or `init.vim` file and type `:PlugInstall`.
Or with MathJax support for typesetting math:
```
Plug 'iamcco/mathjax-support-for-mkdp'
Plug 'iamcco/markdown-preview.vim'
```
### Usage
**Command:**
```
MarkdownPreview
" Open preview window in markdown buffer
MarkdownPreviewStop
" Close the preview window and server
```
> When `MarkdownPreview` command can't open the preview window, you can use the
`MarkdownPreviewStop` command before using `MarkdownPreview` command.
**Default Setting:**
```
let g:mkdp_path_to_chrome = ""
" Path to the chrome or the command to open chrome (or other modern browsers).
" If set, g:mkdp_browserfunc would be ignored.
let g:mkdp_browserfunc = 'MKDP_browserfunc_default'
" Callback Vim function to open browser, the only parameter is the url to open.
let g:mkdp_auto_start = 0
" Set to 1, Vim will open the preview window on entering the Markdown
" buffer.
let g:mkdp_auto_open = 0
" Set to 1, Vim will automatically open the preview window when you edit a
" Markdown file.
let g:mkdp_auto_close = 1
" Set to 1, Vim will automatically close the current preview window when
" switching from one Markdown buffer to another.
let g:mkdp_refresh_slow = 0
" Set to 1, Vim will just refresh Markdown when saving the buffer or
" leaving from insert mode. With default 0, it will automatically refresh
" Markdown as you edit or move the cursor.
let g:mkdp_command_for_global = 0
" Set to 1, the MarkdownPreview command can be used for all files,
" by default it can only be used in Markdown files.
let g:mkdp_open_to_the_world = 0
" Set to 1, the preview server will be available to others in your network.
" By default, the server only listens on localhost (127.0.0.1).
```
**Key Mapping:**
By default this plugin has no mapping: if you want to have your own mappings,
you can map the keys to `MarkdownPreview` for opening the Markdown preview window and
map keys to `StopMarkdownPreview` for closing the preview window.
Examples for mapping the `F8` key to open Markdown preview window and `F9` key to
close preview window:
```
" for normal mode
nmap MarkdownPreview
" for insert mode
imap MarkdownPreview
" for normal mode
nmap StopMarkdownPreview
" for insert mode
imap StopMarkdownPreview
```
For **OS X** users, you can set the `g:mkdp_path_to_chrome` as below (if you use Chrome):
```
let g:mkdp_path_to_chrome = "open -a Google\\ Chrome"
" or
let g:mkdp_path_to_chrome = "/Applications/Google\\ Chrome.app/Contents/MacOS/Google\\ Chrome"
```
See [issue #1](https://github.com/iamcco/markdown-preview.vim/issues/1) for details.
### FAQ
Q: The Firefox preview window didn't close when leaving the Markdown file in Vim.
A: If you want the plugin to auto-close the preview window in Firefox, you have to do some configuration:
1. Open Firefox.
2. Type `about:config` in the address bar and press the `Enter` key.
3. Search for `dom.allow_scripts_to_close_windows` and set its value to `true`.
> You have to know what will happen when you make the above changes.
### Changelog
* 2017/07/16: Add `g:mkdp_open_to_the_world` option.
* 2016/11/19: MathJax support with [mathjax-support-for-mkdp](https://github.com/iamcco/mathjax-support-for-mkdp) plugin.
* 2016/08/28: Set the title of preview page with filename.
* 2016/05/18: Support key mapping and new `g:mkdp_command_for_global` option item.
* 2016/03/12: New Github-like Markdown styles [markdown.css](https://github.com/iamcco/markdown.css) and support task list.
* 2016/01/24: Support to display the local picture in Markdown.
### Buy Me A Coffee ☕️
