kuchaale / Markdown-Templates

Templates for creating scientific, academic and technical documents using Markdown and Pandoc that support equations, code blocks, citations, Unicode symbols and vector graphics.

Markdown Templates

Introduction

This repository contains templates for creating scientific, academic, and technical documents that require equations, citations, code blocks, Unicode characters, and embedded vector graphics using Markdown and Pandoc converter. This software also allows us to write LaTeX documents more easily compared to using pure LaTeX. We discuss the details about these templates and how to write scientific Markdown in general in our article Scientific Writing with Markdown. The original inspiration came from the article How to make a scientific-looking PDF from Markdown (with bibliography).

Requirements

To use these templates, we require the following software.

1. Pandoc for converting between the Markdown files into other document formats.
2. LaTeX for creating PDF documents.
3. Make (software) for using Makefiles.

Then, clone the repository and copy the appropriate template.

Editors

Above, we see how writing documents looks in Visual Studio Code.

Above, we see how writing documents looks in Atom.

We also recommend having an editor for writing Markdown. Please read the Editors section in our article.

Creating Documents

The Creating Documents section in our article explains the template directory structure, build commands and makefiles, and how to set document-specific metadata in the front matter.