https://github.com/skanehira/preview-markdown.vim

Markdown preview plugin for Vim
https://github.com/skanehira/preview-markdown.vim

Last synced: 4 days ago
JSON representation

Markdown preview plugin for Vim

• Host: GitHub
• URL: https://github.com/skanehira/preview-markdown.vim
• Owner: skanehira
• License: mit
• Archived: true
• Created: 2020-01-08T07:24:17.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-14T04:25:07.000Z (almost 3 years ago)
• Last Synced: 2024-08-01T17:41:28.847Z (3 months ago)
• Language: Vim script
• Homepage:
• Size: 38.1 KB
• Stars: 205
• Watchers: 4
• Forks: 24
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# preview-markdown.vim

# This plugin is no longer to develop. If you want to use, you can fork and improve it yourself

This is vim plugin that can preview markdown in Vim terminal.

![](https://i.imgur.com/ME5HBWP.png)

## Requirements

- [MichaelMure/mdr](https://github.com/MichaelMure/mdr) or specified markdown parser

- Vim 8.1.1401 ~

## Installation

e.g dein.vim

```toml

[[plugins]]

repo = 'skanehira/preview-markdown.vim'

```

## Usage

```vim

:PreviewMarkdown [left|top|right|bottom|tab]

```

## Options

| option                           | description                                               |

|----------------------------------|-----------------------------------------------------------|

| `g:preview_markdown_parser`      | Use specified command to parse markdown, default is `mdr` |

| `g:preview_markdown_auto_update` | Update preview window when write to buffer.               |

## Markdown parser

- [MichaelMure/mdr](https://github.com/MichaelMure/mdr)

- [glow](https://github.com/charmbracelet/glow)

- [mdcat](https://github.com/lunaryorn/mdcat)

## Author

skanehira