Move documentation into directory
This commit is contained in:
parent
aa5c959120
commit
c15e24a4e7
3 changed files with 3 additions and 11 deletions
13
README.md
13
README.md
|
@ -16,17 +16,8 @@ Convert markdown files into PDF Documents.
|
||||||
__Note__: All features are completely optional
|
__Note__: All features are completely optional
|
||||||
|
|
||||||
|
|
||||||
### Installation
|
### Documentation
|
||||||
This library isn't on Pypi, but can still be installed using pip:
|
Documentation can be found in the `docs/` directory.
|
||||||
|
|
||||||
pip install https://github.com/RealOrangeOne/md-pdf
|
|
||||||
|
|
||||||
Additionally, you will need the following programs:
|
|
||||||
- `wkhtmltopdf` (With QT - [See Here](https://pypi.python.org/pypi/pdfkit))
|
|
||||||
- `pandoc`
|
|
||||||
- `pandoc-siteproc`
|
|
||||||
|
|
||||||
These packages should be available on most linux distributions, OSX and Windows support is untested!
|
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
$ mdp --help
|
$ mdp --help
|
||||||
|
|
0
docs/installation.md
Normal file
0
docs/installation.md
Normal file
1
docs/referencing.md
Normal file
1
docs/referencing.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Referencing
|
Reference in a new issue