Add basic readme
This commit is contained in:
parent
2fa356cd18
commit
42648d6614
2 changed files with 30 additions and 1 deletions
29
README.md
Normal file
29
README.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
# 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
|
||||
|
||||
|
||||
### 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).
|
|
@ -3,7 +3,7 @@ import argparse
|
|||
|
||||
def parse_args():
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("-v", "--verbose", help="Display verbose output", action="count", default=0)
|
||||
parser.add_argument("-v", "--verbose", help="Set verbosity level (repeat argument)", action="count", default=0)
|
||||
parser.add_argument("--update-csl", help="Update CSL files", action="store_true")
|
||||
parser.add_help = True
|
||||
return parser.parse_args()
|
||||
|
|
Reference in a new issue