ikey4u / nvim-previewer

A concisemark previewer plugin for neovim

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nvim-previewer

  • Introduction

    A nvim file previewer written in Rust, it only supports markdown file parsed by concisemark for now.

  • Installation

    You should install these prerequisites firstly

    Then install this plugin with vim-plug using the following configuration

      Plug 'ikey4u/nvim-previewer', { 'do': 'cargo build --release' }
    

    To cutmoize the broswer and listening port, using these options

      " if not set, the default value is empty
      let g:nvim_previewer_browser = "firefox"
    
      " if not set, the default value is 3008
      let g:nvim_previewer_port = 3008
    
  • Usage

    nvim-previewer provides two themes, your can run :Preview or :PreviewAlt to preview your markdown file in broswer.

    nvim-previewer supports exporting markdown to latex source, and compile the latex source to PDF document (depends on latex). To compile the latex source to PDF file, you should install texlive and rsvg-convert. If you have cargo installed, you can install rsvg-convert using the following command

      cargo install --git https://gitlab.gnome.org/GNOME/librsvg.git --tag 2.55.90
    

    If you just want to get the latex source, then texlive and rsvg-convert are not required.

  • Logs

    Log files are stored into nvim-previewer directory under the cache directory of neovim (get it using :echo stdpath('cache') in daily.

About

A concisemark previewer plugin for neovim


Languages

Language:Rust 93.8%Language:Vim Script 5.6%Language:Makefile 0.6%