Write your well formatted professional paper, essay or thesis at ease with markdown and latex and export it as PDF (with bibliography).
- Step 0: Clone or fork this repository
- Step 1: Write your paper using Pandoc Markdown and LaTeX chapter-wise by editing and adding files in the source directory
- Step 2: Customize your output by editing the markdown preface
- Step 3: Run
make.shfrom the command line - Step 4: Your shiny PDF waits for you in the
outdirectory
This paper has been built using this boilerplate. It includes some math, a lot of tikz images and a bunch of code listings, so to see if this boilerplate fits your needs check the example:
Example paper built with pandoc boilerplate
Follow instruction on installing pandoc in this link http://pandoc.org/installing.html. For PDF output, you’ll also need to install a LaTeX distribution on your machine. We recommend to use MiKTeX as the boilerplate has been successfully tested there.
After the installation and for the first time running the boilerplate, MiKTeX may ask you to install all the dependencies which can take several minutes if you haven't run it before.
All configuration options are handled in 01_preface.md.
To set the title, subtitle, authors, institute anmd date of the paper, replace the placeholders with your values. Don't forget to edit \fancyhead[LE,RO]{<YOUR TITLE HERE> \hfill \thepage} as it handles the page heads.
You can replace ieee.csl with the Citation Style Language file of your need. Then replace the reference at csl: [ieee.csl].
Set your language in header-includes: [...] \usepackage[<YOUR LANGUAGE>]{babel}
See pandoc, LaTeX and Tikz documentation for more information.
The project is organized into chapters. You can adopt this structure and add more chapters by simply adding files with a prefix for sorting. The chapters will be concatenated alphabetically, so you can continue the numbering or also declare sub chapters as 02_a, 02_b and so on, for example. But you are free to write the whole paper in a single document if you want so.
To add citations to your bibliography, simply paste them intro citations.bib. The boilerplate uses BibTeX for the bibliography. Platforms like Google Scholar allows you to simply copy the citation code for BibTeX with a single click.
On Linux, simply run ./make.sh . On Windows, it is recommend to use git bash to run the commands.