ajuvercr / markdown-templates

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

A quick demo to getting papers written quickly in markdown

Pandoc is an awesome tool! This is especially true once properly configured for scientific writing. Personally, I write all my papers in Markdown — or RMarkdown for the fancy stuff that requires generating figures — and leave pandoc to automatically produces pdfs and LaTeX output. In fact, all my builds are simultaneously generated for 3 separate versions — corresponding to the major style guides in computer science — ACM, IEEE and LNCS formatting. I get really distracted writing LaTeX directly -- it's really easy to lose track on what you want to say when writing when you could spend half the day type-setting and resizing figures. This is where writing in markdown really shines; it allow's you the flexibility of LaTeX -- since TeX can be embedded at any part of the document -- without you going down the long road of type-setting and losing your train of thought. Best of all, if you're about to submit the paper and need to finally focus on typesetting it's easy to generate a LaTeX output of your work and edit as you normally would using the classic TeX workflow.

Installation

This project uses Docker to facilitate reproducibility. As such, it has the following dependency:

  • Docker -- available here

To generate a docker image named workbook, run:

docker build -t workbook .

Run

To start the docker image run (note: omit .md extension):

docker run -it --mount src="$(pwd)",target=/paper,type=bind -e PAPER=my_paper workbook

Building papers the hard way:

The version of pandoc that I started on involved a brittle tool-chain with very fragile haskel filters, as such, this method of running pandoc to build papers is not advised. Packages used to build the paper include:

Feel free to ask me questions via email about markdown/pandoc and R integration. The corresponding pdfs can be viewed here as ACM, IEEE and LNCS.

About


Languages

Language:TeX 98.0%Language:Python 1.2%Language:Makefile 0.4%Language:Dockerfile 0.4%