mdpaper

Blazingly fast highly opinionated markdown to pdf 1.5 converter aimed at writing scientific papers, e.g. in University.

Getting started

Installation

Either download the latest release from the releases page or install with go:

go install github.com/sett17/mdpaper/v2@latest

Usage

Every available option can be set in the markdown file with a YAML frontmatter.

mdpaper my_paper.md

You can also include multiple markdown files, which will act as if they were concatenated into a single file.

mdpaper abstract.md draft.md ackowledgements.md

You can also set the path to the config file (e.g. if you want to have multiple configs) with -c or --config.

mdpaper -c single.yaml my_paper.md

How do I write a paper?

Everything from features through to configuration, and supported elements is documented in the References file.

Acknowledgements & Known Issues

Thanks to the people behind:

• goldmark for the markdown parser

• bibtex for the bibtex parser

• mermaid for great looking diagrams

• chroma for the code highlighting

• Furqan Software for goldmark math extender code

• Paragraphs that are split in the beginning may be out of order

  • use '\fill' in the meantime to force a column break and avoid the splitting