markdown-paper

Scientific paper in markdown using LaTeX.

See markdown-talk for template for a beamer-based presentation.

The source of this document is written in markdown (file paper.md) and translated to latex using pandoc and customized templates located in the templates folder. References are stored in references.bib in bibtex format.

The Makefile details how the translation works. If you are on linux, simply calling make in the parent directory will compile the report to a pdf-format if all dependencies are installed. Edit the variables in the Makefile to choose a template (located in ./templates).

So far, I have used it only with ./templates/elsarticle-template-1.latex but others may follow.

Usage

1. Install the dependencies

   sudo apt-get install pandoc pandoc-citeproc
   pip install pandoc-fignos
   

2. Clone this repository

   git clone
   

3. Edit Makefile to choose a template

4. Write paper in paper.md, refs in references.bib, compile with make

NOTE: paper.md contains example code for tables, figures, equations, references and so on.

Recommended Editor/Tools

I think it works very nicely to write markdown-based papers in the atom editor. The following packages are useful:

• autocomplete-bibtex

  Allows to get a drop-down list of references when writing @citation. However, it is currently necessary to put a global .bib file into the config file config.cson (see documentation):

  'autocomplete-bibtex':
    'references': [
      '/path/to/references.bib'
      '/path/to/references.json'
    ]
  

• markdown-preview for nice syntax highlighting

• pdf-view for viewing the PDF in Atom directly

Dependencies

• pandoc
• pandoc-fignos
• pandoc-citeproc
• a latex-distribution (e.g., texlive) including bibtex

---

Matthias Mittner [email protected]