jaantollander / 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. Shell such as Bash for invoking the build scripts.

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.

markdown-templates's Issues

How to add a docx output?

Thank you very much Jaan for your work of putting together thsi repository.

Following your method, I tried to convert the markdown with tex equation into docx but I cannot make it work. Do you have any advice?

I added this bit of code in the makefile:

docx:
	pandoc $(FILENAME).md \
	--citeproc \
	--from=markdown+tex_math_single_backslash+tex_math_dollars \
	--to=docx \
	--output=$(BUILDDIR)/$(FILENAME).docx \
	--mathjax

But when I run make docx I got this error:

make docx                                                                    ✹ ✭ 20:26:51
pandoc essay.md \
--citeproc \
--from=markdown+tex_math_single_backslash+tex_math_dollars \
--to=docx \
--output=build/essay.docx \
--mathjax
[WARNING] Could not convert TeX math '
  f(a)=\frac{1}{2πi}∮_γ\frac{f(z)}{z-a}\,dz.
  \tag{1}
  \label{eq:1}
  ', rendering as TeX:
  f(a)=\frac{1}{2πi}∮_γ\frac{f(z)}{z-a}\,d
      ^
  unexpected "{"
  expecting "%", "\\label", "\\nonumber" or whitespace
[WARNING] Could not convert TeX math '\eqref{eq:1}', rendering as TeX:
  \eqref{eq:1}
        ^
  unexpected "{"
  expecting "%", "\\label", "\\nonumber" or whitespace

and the equation is not rendered properly like in pdf or html. Any idea of what I am doing wrong?

atom: make pdf -> unkown command

as an Atomnewbie I try to set the template up. Opening the Terminal (powershell) in Atom to run 'make pdf' as explained in video... tried various commands.... not working. What I am I doing wrong? Are there good ressources where I can learn about this problem?