Home / Linux / Miscellaneous

Markdown preview plugin for Vim

preview-markdown.vim This is vim plugin that can preview markdown in Vim terminal. Requirements MichaelMure/mdr or specified markdown parser Vim 8.1.1401 ~ Installation e.g dein.vim [[plugin]]
Information
Category: Linux / Miscellaneous
Watchers: 4
Star: 208
Fork: 25
Last update: Sep 22, 2023
Resource links
https://github.com/skanehira/preview-markdown.vim

preview-markdown.vim

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

Requirements

Installation

e.g dein.vim

[[plugin]]
repo = 'skanehira/preview-markdown.vim'

Usage

:PreviewMarkdown

Options

option description
g:preview_markdown_vertical Open window vartical when value is 1
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. This unstill support Neovim

Markdown parser

Author

skanehira

4 Open More issues
Closed

How do I install it?

I have tried with 'Plug', but it did not work ...

opened Jan 28, 2021 by UltiRequiem 8
Closed

Cannot close preview window with q if termwinkey is set

Preview window doesn't close and receive any keys when I type q.

I found it happens if termwinkey is set to another key that is not <C-w>. Like:

set termwinkey=<C-l>

It goes fine if I remove above line from my vimrc.

opened Jan 24, 2021 by mmktomato 7
Closed

Add auto_update feature for neovim

Hi, I'm really sorry to send the same pull request twice. Since I forgot to make a branch before sending the pull request, I tried to fix it but accidentally closed the previous pull request.

This commits allows to use auto_update feature for Neovim users.

  • To save a job id that is made by termopen, I made a new variable s:preview_job_id.

  • To close the buffer of a terminated terminal, I added the following lines:

  if has('nvim')
    autocmd TermClose * exe "bd! " . expand('<abuf>')
  endif
opened Sep 18, 2021 by AkiraHasegawa1997 5
Closed

preview window in the left

when I press :PreviewMarkdown and enter, the preview window shows in the left, can I modify it to make it display in the right

opened Apr 2, 2021 by georgemaxx 5
Closed

glow errors out with "Error: missing markdown source"

Hi!

I've set up the plugin so that it uses glow (let g:preview_markdown_parser = "glow") and when I run :PreviewMarkdown on a buffer with a .md file, it does open a new window and runs glow, but it errors out with:

Error: missing markdown source

It feels like preview_markdown#preview() is not passing any file name to glow.

Am I doing something wrong?

Thank you so much for the plugin and for any help! :bowing_man:

opened Feb 5, 2020 by mtpereira 4
Closed

Fix cant open current file for vim

The markdown currently open in vim could not be previewed, so it was fixed.

Please give me a review🙇‍♂️

opened Mar 22, 2020 by takezyou 3
Open

Error E900: Invalid channel id

Hello, I cannot use PreviewMarkdown as it always returns this error:

Error detected while processing function preview_markdown#preview[37]..<SNR>80_stop_job:                                                                                                                 
line    4:
E900: Invalid channel id
Press ENTER or type command to continue

I have tried with both mdr and glow. However, I can successfully can mdr myfile.md or glow myfile.md.

My configuration:

NVIM v0.4.4
Build type: Release
LuaJIT 2.1.0-beta3
Compilation: /usr/bin/cc -g -O2 -fdebug-prefix-map=/build/neovim-u4YhjF/neovim-0.4.4=. -fstack-protector-strong -Wformat -Werror=format-security -Wdate-time -D_FORTIFY_SOURCE=1 -DDISABLE_LOG -Wdate-time -D_FORTIFY_SOURCE=1 -O2 -DNDEBUG -DMIN_LOG_LEVEL=3 -Wall -Wextra -pedantic -Wno-unused-parameter -Wstrict-prototypes -std=gnu99 -Wshadow -Wconversion -Wmissing-prototypes -Wimplicit-fallthrough -Wvla -fstack-protector-strong -fno-common -fdiagnostics-color=always -DINCLUDE_GENERATED_DECLARATIONS -D_GNU_SOURCE -DNVIM_MSGPACK_HAS_FLOAT32 -DNVIM_UNIBI_HAS_VAR_FROM -I/build/neovim-u4YhjF/neovim-0.4.4/build/config -I/build/neovim-u4YhjF/neovim-0.4.4/src -I/usr/include -I/usr/include/lua5.1 -I/build/neovim-u4YhjF/neovim-0.4.4/build/src/nvim/auto -I/build/neovim-u4YhjF/neovim-0.4.4/build/include
Compiled by [email protected]
opened Oct 26, 2021 by jeertmans 0
Open

mdr preview only a part of markdown file

Screenshot from 2021-03-30 00-23-27

This issue is described in the image above. I also already trying with glow but still getting an error: no such tmp file exception. Here is my nvim config:

Plug 'skanehira/preview-markdown.vim'
let g:preview_markdown_vertical=1
let g:preview_markdown_parser='glow'
opened Mar 29, 2021 by logbasex 6
Open

Render markdown from stdin rather than tmpfile

I noticed that there's a bunch of code dealing with creating/reading/cleaning up temporary files, but also that all of the markdown renderers support reading from stdin:

  • echo "foo" | glow -
  • echo "foo" | mdr
  • echo "foo" | mdcat

Would it be worth to simplify the code and generalize the parser command support to just take any command that reads from stdin?

opened Aug 31, 2020 by shazow 2
Open

E916 error when :PreviewMarkdown on any file

Hi,

I've installed the plugin as described with Vundle and also installed mdr as well as glow. Whenever I try to get the Preview with :PreviewMarkdown I get the following error:

Error detected while processing function preview_markdown#preview:
line   70:
E916: not a valid job
Press ENTER or type command to continue

then, an new empty window with [No Name] shows up.

I've tried with

let g:preview_markdown_parser = "mdr"

as well as with

let g:preview_markdown_parser = "glow"

, same result.

I've copied the mdr binary into /usr/local/bin and made sure it's in $PATH. When I run

mdr myFile.md

it works just fine. My vim version is:

VIM - Vi IMproved 8.0 (2016 Sep 12, compiled Mar 18 2020 18:29:15)
Included patches: 1-1453
opened Apr 30, 2020 by Schnet 2

Contents

    ruanyf a wrapped markdown renderer based on markdown-it
    iamcco markdown preview plugin for (neo)vim
    liuchengxu :herb: Another elegant statusline for vim
    miyakogi Real time markdown preview plugin for vim
    c9s Operating Kubernetes Cluster from Vim, in Vim
    kat0h A markdown previewer for Vim and Neovim
    Shougo Commands for ddu.vim
    leafOfTree vim-vue-plugin - Vim syntax and indent plugin for .vue files.
    npm npm's markdown parser
    yusukebe GitHub CLI extension to preview README looks the same as GitHub.
    Shougo Zsh completion for ddc.vim
    xojs Vim plugin for XO
    beauwilliams Simple AutoWrite Plugin compatible with most if not all vim distributions (Vim/Neovim)
    jhermann :construction: [BETA, not feature complete] A Markdown lexer for Pygments to highlight Markdown code snippets.
    inacho Markdown editor for Bootstrap with preview, image upload support, shortcuts and other features.
    yann-yinn Find your Vim commands faster : An interactive cheat sheet for vim. (Site might be slow to start, please wait )
    dofy Vim 实操教程（Learning Vim）Vim practical tutorial.
    iqxd mine sweeping game in vim and neovim
    sanhajio Synonyms.vim is a frontend plugin that allows you to show synonyms in a vim split
    lambdalisue 🎭 Guise is a Vim/Neovim plugin that opens a new tab page rather than invokes a new nested instance when a user tried to open a new Vim/Neovim through a job or terminal on the instance.
    chr4 Improved nginx vim plugin (incl. syntax highlighting)
    Share this repo

    Related Repos


    Miscellaneous
    14
    the ultimate compact fzf gh extension
    gennaro-tedesco the ultimate compact fzf gh extension Installation • Usage • Customisation • Feedback gh-f is the ultimate, compact and snappy fzf extension for gh cl
     
    Miscellaneous
    6
    MacOS Wallpapers for linux desktop
    vinceliuice MacOS Wallpapers for linux desktop WhiteSur (Big Sur) Wallpapers Monterey Wallpapers Installation Install Gnome Backgrounds (wallpaper will change acc
     
    Miscellaneous
    3
    A docker bundle with *arr apps ready to deploy on your linux machine.
    bolchisb Plex Home Media integrations This package is created for those who are not experts in linux servers and docker. If you follow these steps you'll be ab
     
    Miscellaneous
    3
    Vim-textobj-string is a Vim plugin to provide text objects to select a string
    rbtnn vim-textobj-string is a Vim plugin to provide text objects (as and is by default) to select a string.
     
    Miscellaneous
    3
    automatically quote arguments to commands like `git commit -m`
    ianthehenry zsh-autoquoter zsh-autoquoter is a zle widget ("zsh plugin") that will automatically put quotes around arguments to certain commands. So instead of ha
     
    Miscellaneous
    34
    PyTorchCV: A PyTorch-Based Framework for Deep Learning in Computer Vision.
    donnyyou PyTorchCV: A PyTorch-Based Framework for Deep Learning in Computer Vision @misc{CV2018, author = {Donny You ([email protected])}, howpubl
     
    Miscellaneous
    276
    Documentation on building a HTTPS stack in AWS with HAProxy
    jvehent Guidelines for HAProxy termination in AWS Document status NOT READY $Revision: $ @ 2022-01-14 19:00 PST Author Julien Vehent Review CloudOps Table of
     
    Miscellaneous
    8.3k
    Spinnaker is an open source, multi-cloud continuous delivery platform for releasing softwa...
    Spinnaker Welcome to the Spinnaker Project Spinnaker is an open-source continuous delivery platform for releasing software changes with high velocity and confid
     
    Miscellaneous
    52
    A must-have configuration for Spacemacs users after defecting to Vim
    yetone 🪐 My Neovim Configuration 🚀 A must-have configuration for Spacemacs users after defecting to Vim If you want the power of VSCode, the interactivity
     
    Miscellaneous
    12
    This repo is for firmware updates, software files, and other important resources for the M...
    Takiiiiiiii Miyoo Mini Firmware and Configured SD This repository contains a debloated and improved SD card image for the Miyoo Mini. Latest Firmware Update Packa
     
    Miscellaneous
    7
    This app is created that using with Shell Script and Zenity Library.
    kaansertel CV Hazırlama (Shell Script - Zenity Kütüphanesi) Linux Araçları ve Kabuk Programlama dersi kapsamında,Shell script ve Zenity Kütüphanesi kullanılarak
     
    Miscellaneous
    7
    Docker container for PlexAutoSkip
    mdhiggins PlexAutoSkip Official Docker Container Docker container for PlexAutoSkip Version Tags Tag Description latest Stable release Usage docker-compose ple
     
    Miscellaneous
    29
    An open source meme???
    KCGD Open source spiderman meme Haha spiderman make a presentation lol Install gimp This meme requires gimp, install through install_deps.sh chmod +x insta
     
    Miscellaneous
    35
    Script to patch iOS app so we can later use it on Apple Silicon devices.
    Co2333 AppleSiliconUIKitPatch Script to patch iOS app so we can later use it on Apple Silicon devices. App should be decrypted if was downloaded from App Sto
     
    Miscellaneous
    20
    dots configured after setting up NixOS on tmpfs
    Sam1431 λ Idempotent Dotfiles SETTING UP NIXOS , MY WAY NixOS with tmpfs (Sway WM) Disclaimer: This is not a community framework or distribution. It's a priva