Pandoc Research Paper Template

This is a template repository for writing scientific papers that can be submitted to journals.

Compiling

Make and Pandoc are used for compiling the metadata and markdown files into LaTeX. pdfTeX and BibTeX from TeX Live is used for generating the final PDF and resolving citations.

The Pandoc filter pandoc-crossref is used for numbering figures and references.

Note: Make sure that you are using the same version of Pandoc that pandoc-crossref was compiled with.

The formatting of the paper can be arbitrarily changed without changing the content using the template.latex file in the templates directory.

Options for Pandoc, such as link-citations can be specified through the metadata.yaml file.

The citation style can be specified using a CSL file in the root directory called citation-style.csl. You can download the CSL file for most journals using the Zotero Style Repository.

Compiling Using Make

Make has a recipe to create a PDF file of arbitrary name using:

make $(paper_name).pdf

A final ZIP file, which can be used for publishing the paper, is compiled using:

make publish

Everything inside the build directory can be removed for a clean build using:

make clean

Compiling Using Visual Studio Code Tasks:

The make commands can be invoked from tasks in Visual Studio Code using the Command Palette. The default keyboard shortcuts for the command Palette are F1 and Ctrl + Shift + P.

These tasks can also be used from the 'Run and Debug' menu. It will also open the generated PDF file in Visual Studio Code automatically after compiling.

Attribution

The template.latex is a modified version of the IEEE template from stsewd/ieee-pandoc-template.

The Makefile automatically downloads the ieee.csl file from the Zotero Styles Repository if no citation-style.csl exists in the root directory and no url is provided for make download_csl.