hirnsalat / polyurethane

A skeleton project for writing papers in markdown. Supports citations and output in pdf (via LaTeX) and html.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

polyurethane

A skeleton project for writing papers in markdown. Supports citations and output in pdf (via LaTeX) and html.

Setup

For editing: just keep using whatever you're using to edit text. most editors will highlight markdown syntax and some also provide rendering previes, e.g. atom, vscode, sublime, etc. alex really likes Typora. it gets out of the way, is pretty, and works without installing anything else (as far as i can tell), and also uses pandoc in the background.

For building the pdf: install pandoc, pandoc-citeproc (for the references) and pdflatex (for building latex-style pdfs)

For debian-based systems and windows with an activated linux-subsystem it should just be:

sudo apt install pandoc pandoc-citeproc pdflatex

For mac, there's brew install pandoc. i assume the other packages should be there as well.

Alternatively, you can also find pandoc-installers for all OSes here. But you'll need to install pdflatex some other way, e.g. by installing MiKTeX.

Build

Build pdf pandoc --filter pandoc-citeproc main.md -o build/main.pdf. There's a shell script that automates the build (build.sh) and also uses pandoc.

The references.json can be generated using e.g. zotero (install better-bibtex and export as "better csl").

If you want html, run pandoc --standalone --filter pandoc-citeproc main.md -o build/index.html (the additional flag adds a header and a body-tag).

For media-wiki-syntax use pandoc --filter pandoc-citeproc main.md -t mediawiki -o build/main.mediawiki.txt.

About

A skeleton project for writing papers in markdown. Supports citations and output in pdf (via LaTeX) and html.

License:MIT License


Languages

Language:Shell 100.0%