Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/junegunn/vim-xmark
Live markdown preview for Vim on macOS (UNMAINTAINED; see https://github.com/iamcco/markdown-preview.nvim)
https://github.com/junegunn/vim-xmark
Last synced: about 2 months ago
JSON representation
Live markdown preview for Vim on macOS (UNMAINTAINED; see https://github.com/iamcco/markdown-preview.nvim)
- Host: GitHub
- URL: https://github.com/junegunn/vim-xmark
- Owner: junegunn
- Created: 2014-12-03T17:20:44.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T02:59:46.000Z (over 5 years ago)
- Last Synced: 2024-07-10T16:02:37.032Z (3 months ago)
- Language: CSS
- Homepage:
- Size: 44.9 KB
- Stars: 135
- Watchers: 5
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
vim-xmark
=========
Markdown preview on OS X. Uses AppleScript to resize the windows.
Vim 8 is required for asynchronous rendering.
Screenshot
----------
### `Xmark>` on iTerm2
### `Xmark<` on MacVim
Prerequisites
-------------
Xmark requires [Homebrew][b] and [Google Chrome][c].
Installation
------------
Using [vim-plug](https://github.com/junegunn/vim-plug):
```vim
Plug 'junegunn/vim-xmark', { 'do': 'make' }
```
Usage
-----
`:Xmark` command is added for Markdown files. After running the command, the
rendered content will be reloaded on the browser every time you save the file.
```vim
" Does not resize nor move the windows
:Xmark
" Vim on the left, browser on the right
:Xmark>
" On the left
:Xmark<
" On the top
:Xmark+
" On the bottom
:Xmark-
" Reload the page and resize the windows by saving it
:w
" Turn off Xmark
:Xmark!
```
If you see an error (e.g. `osascript is not allowed assistive access`), make
sure that your terminal emulator (or MacVim) is in the list in `System
Preferences` -> `Security & Privacy` -> `Privacy` -> `Accessibility`. (You can
drag and drop the application icon to the list.)
Known issues
------------
- Resizing does not work if the terminal emulator is in fullscreen mode
Acknowledgment
--------------
- [GitHub style CSS][css] is based on [github-markdown-css][gmc] by [Sindre Sorhus][s] licensed under MIT
- Previous version of CSS was based on: https://gist.github.com/killercup/5917178
License
-------
MIT
[b]: http://brew.sh/
[p]: http://johnmacfarlane.net/pandoc/
[c]: http://www.google.com/chrome/
[gmc]: https://github.com/sindresorhus/github-markdown-css
[s]: https://github.com/sindresorhus
[css]: plugin/css/github-markdown.css