@pixelastic/markdown-preview

0.0.11 • Public • Published

markdown-preview

Renders a preview of a markdown text in your browser.

Usage

$ markdown-preview ./readme.md

Preview

Installation

Install globally with yarn global add @pixelastic/markdown-preview

Integration with vim

I've added the following mapping to my after/ftplugin/markdown.vim to see a preview when I press F5.

nnoremap <silent> <buffer> <F5> :call MarkdownPreview()<CR>
function! MarkdownPreview()
  silent execute ':!nohup markdown-preview % &>/dev/null &'
  redraw!
endfunction

Limitations

  • Uses a hard-coded /tmp/ to store the HTML file
  • Uses a hard-coded google-chrome to open the file
  • Does not handle local images

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @pixelastic/markdown-preview

    Weekly Downloads

    0

    Version

    0.0.11

    License

    MIT

    Last publish

    Collaborators

    • pixelastic