Skip to main content

smdv: a simple markdown viewer

Project description

smdv

a simple markdown viewer for linux.

Dependencies

Required

  • python3 pointing to Python 3.6+.
  • Pandoc [pip3 install pandoc | apt install pandoc | pacman -S pandoc | ... ]
  • Flask [pip3 install flask | apt install python3-flask | pacman -S python-flask | ... ]
  • Websockets [pip3 install websockets | apt install python3-websockets | pacman -S python-websockets | ... ]

Optional

  • Jupyter (to view jupyter notebooks) [pip3 install jupyter | apt install jupyter | pacman -S jupyter | ... ]
  • Neovim Remote [pip3 install neovim neovim-remote]

Installation

    pip3 install smdv

Configuration

smdv listens to a single environment variable: SMDV_DEFAULT_ARGS. As an example, below you can see how smdv can be configured to always open in firefox on port 9999 by placing the following line in your .bashrc:

SMDV_DEFAULT_ARGS="--browser firefox --port 9999"

Consult smdv --help to see which flags can be used.

Compatibility with neovim

This viewer was made with neovim compatibility in mind. With the use of neovim-remote, this script is able to open files in the current neovim window (or spawn a new neovim window if there is no window available).

However, to make it fully compatible with neovim and to make neovim able to sync its current file to the viewer, neovim-remote should be installed and the following line should be added to your init.vim:

    " sync on save
    autocmd BufWritePost *.md silent execute '!smdv 'expand('%:p')' -v "'.v:servername'"'

This setting will sync the file to the viewer after every save.

Compatibility with vim-instant-markdown

Alternatively, if syncing after every save is not enough, smdv can also be used in conjuction with vim-instant-markdown for instant markdown previews. Install the vim-plugin and add the following line to your vimrc:

let g:instant_markdown_python = 1

This line disables the default javascript daemon handling instant previews in favor of smdv. Consider removing the sync-on-save line defined above when using this option; both options are not completely compatible.

Screenshots

markdown preview

smdv-dir

folder view

smdv-dir

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for smdv, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size smdv-0.1.1-py3-none-any.whl (15.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size smdv-0.1.1.tar.gz (14.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page