Vivify

Vivify brings your files to life in the browser! Vivify is primarily made to render Markdown and Jupyter Notebooks, but will also serve as a directory browser and let you view code files with syntax highlighting. See below for features!

Features

• view Markdown with various features
• view Jupyter Notebooks
• view other plain text files with code syntax highlighting
• view & navigate directories, hidden "back to parent directory" button at the top-left of the file viewer
• easy to integrate with any editor for live synchronization (see editor support)
• Vivify server starts lazily and automatically shuts down when no more viewers are connected
• various customization options

If you need any additional features, feel free to open an issue or contribute!

Markdown features

• full basic and extended syntax support
• KaTeX math
• graphviz/dot graphs
• Mermaid diagrams & charts
• GitHub alert blocks
• links to other files: relative links like in GitHub as well as absolute file links
• add styles, classes, ids or other attributes directly from Markdown
• table of contents with [[toc]]
• <kbd> tags, e.g. to style keyboard shortcuts

You can find examples for all supported features in the files in the tests/rendering directory. In case you are looking at these on GitHub, keep in mind that GitHub doesn't support some of the features that Vivify supports so some things may look off.

Editor Support

Vivify has a simple API to integrate your favorite editor so the viewer live updates to any changes as you are typing and the scrolling is smoothly synchronized!

See below for a list of existing editor plugins. In case your favorite editor is not yet supported, use these as an example to write your own and add it to the list!

Existing integration

• for Vim and Neovim: vivify.vim

Installation

Once you have Vivify installed, use it by running viv with any text file or directory as an argument! See below for installation options.

Packaged

• Homebrew: brew install jannis-baum/tap/vivify
• AUR: e.g. yay -S vivify

Manual

• download & unpack the latest release for your system (macOS or Linux)
• add the two executables to your $PATH

Compile yourself

• make sure you have yarn, make and zip installed
• clone the repository
• run yarn
• run ./configure <install_dir>
• run make install

[!TIP]
If you are having trouble building Vivify, or you'd like more detailed build instructions, see our CONTRIBUTING page

Get help

Is something not working or do you have any questions? Start a discussion!

Acknowledgments

I have been using iamcco/markdown-preview.nvim for the longest time and started this project because

1. I wanted a Markdown viewer that works with and without Vim and
2. I wanted a Markdown viewer that supports file links like in GitHub.

Looking at iamcco/markdown-preview.nvim helped in development, particularly with regard to which npm packages to use.