Automatically compile Markdown notes into beautiful Latex PDFs or other supported pandoc formats!
Theme: material default-community
Papyrus is an asynchronous Markdown conversion plugin that allows users to have a latex-like editing experience while writing Markdown. By utilizing the Pandoc universal document converter you can write Markdown and Latex syntax in the same file and convert it into a PDF or other Pandoc supported document types.
Features
- Asynchronous compilation
- Ability to set custom Pandoc command-line arguments
- Optional templates
Supported Engines: pdflatex, lualatex, xelatex, latexmk, tectonic, wkhtmltopdf, weasyprint, pagedjs-cli, prince, context, and pdfroff.
Add the following to your .vimrc or init.vim file to install the plugin using a plugin manager of your choice. Here are some examples:
" vim-plug
Plug 'abeleinin/papyrus'
" packer.nvim
use 'abeleinin/papyrus'
" vundle
Plugin 'abeleinin/papyrus'I strongly recommend also installing the vim-pandoc-syntax plugin to visualize Latex special characters.
Templates are optional
Move the Latex template files from wherever your plugin is installed (~/papyrus/templates/latex/*) to the pandoc templates folder. The pandoc template folder depends on the OS you're using:
- Unix, Linux, macOS:
$HOME/.local/share/pandoc/templatesor$HOME/.pandoc/templates - Windows:
C:\$HOME\AppData\Roaming\pandoc\templates
If the templates or pandoc folder doesn't exist then you need to create them and put the template files into the new directory. You can also find the default User data directory by checking pandoc --version.
After installation, copy the following configurations into your .vimrc or init.vim file to configure Papyrus to your specification.
" Specify a Latex Engine from the supported list above
let g:papyrus_latex_engine = 'xelatex'
" Specify any built-in pdf viewing option. It's recommended to use
" a pdf viewer with automatic updates on save.
let g:papyrus_viewer = 'zathura'
" Recommended keybinding for compiling and viewing documents
" Adding optional formattings is also possible by
map <leader>pc :PapyrusCompile<CR>
map <leader>pa :PapyrusAutoCompile<CR>
map <leader>pv :PapyrusView<CR>
map <leader>ps :PapyrusStart<CR>g:papyrus_pandoc_args: Add custom pandoc compilation arguments.
g:papyrus_autocompile: Default set to BufWrite alternative autocmd events can be used to trigger auto-compilation.
g:papyrus_output_path: Set a custom output folder path in the format /path/to/folder/. Do not include $HOME or ~.
g:papyrus_output_format: Default output format is set to pdf which can be changed to any supported pandoc output format which is listed when running pandoc --list-output-formats.
g:papyrus_template: Set a template from supported options.
If a command has an optional argument you can add custom mappings for different compilation formats. For example:
" Compile current file to pdf
map <leader>pcp :PapyrusCompile pdf<CR>
" Compile current file to html
map <leader>pch :PapyrusCompile html<CR>After every compilation either the message Papyrus: Compilation Succeeded! will appear at the bottom of the window or Papyrus: Compilation Failed with exit status X. After a failed compilation the pandoc compilation errors are displayed in a quickfix list which can be viewed using :copen.
Optional arguments allow you to change the current file output format. Possible output formats are listed when running pandoc --list-output-formats.
Executes a pandoc command using jobstart to compile the current open md file into a pdf with the same name using either the g:papyrus_pandoc_args or g:papyrus_template.
Executes an autocmd when the g:papyrus_autocompile event is triggered which runs :PapyrusCompile.
Opens the current file in the specified pdf viewer from the g:papyrus_viewer variable.
Runs :PapyrusView and :PapyrusAutoCompile to automatically start an editing environment.
Copies the specified template file into the current file from /templates/md/g:papyrus_template.
Runs :PapyrusHeader and :PapyrusStart to create a new editing environment for the specified template.
# Insert image from current directory
# Add figure caption
# Insert images from different directory
# Append {width="50%"} to adjust dimensions
{width="50%"}To add custom fonts you first need to verify that the font is downloaded to your systems. For example, on Mac, you can use the Font Book application to add any font from the internet. There are two ways to specify a font using Papyrus. First, you can use the mainfont variable in the YAML heading at the top of your markdown document:
---
title: Custom Font
author: Author
date: xx-xx-xxxx
mainfont: Droid Sans Fallback
---The second way is to use the g:papyrus_pandoc_args variable in your init.vim or .vimrc file:
let g:papyrus_pandoc_args = '-V mainfont="Droid Sans Fallback"'Papyrus supports two templates which you can view in the pdf directory. Custom template files can be created using pandoc-latex-templates. If you create a cool template feel free to submit a pull request!
" Specify the current template by its file name
let g:papyrus_template = 'default'
This is a demo from my notes on the Book of Proof. I'm using the Vim Pandoc Syntax plugin to automatically insert special characters and clean up the document. Also, in the demo, you can see that pandoc supports the ability to insert Latex syntax inside the Markdown document.