This repository has been archived on 2023-03-26. You can view files and clone it, but cannot push or open issues or pull requests.
md-pdf/README.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2017-04-05 16:24:12 +01:00
# MD-PDF
[![CircleCI](https://img.shields.io/circleci/project/github/RealOrangeOne/md-pdf.svg?style=flat-square)](https://circleci.com/gh/RealOrangeOne/md-pdf/)
[![Github Releases](https://img.shields.io/github/downloads/RealOrangeOne/md-pdf/latest/total.svg?style=flat-square)](https://github.com/RealOrangeOne/md-pdf)
Convert markdown files into PDF Documents.
### Features
- Multiple output formats
- Bibliography with 1400+ referencing formats
- Templating support (powered by [`jinja2`](http://jinja.pocoo.org/))
- Cover pages
- Page numbers in footer
- Student / TurnItIn Number in header / cover
__Note__: All features are completely optional
2017-04-26 13:24:08 +01:00
### Documentation
Documentation can be found in the `docs/` directory.
2017-04-26 12:34:29 +01:00
2017-04-05 16:24:12 +01:00
### Usage
$ mdp --help
usage: mdp [-h] [-v] [--update-csl]
optional arguments:
-h, --help show this help message and exit
-v, --verbose Set verbosity level (repeat argument)
--update-csl Update CSL files
### Configuration
An example configuration file can be found [Here](https://github.com/RealOrangeOne/md-pdf/blob/master/test-files/mdp.yml).