archive/md-pdf
Archived
1
Fork 0
Code Releases Packages Activity

Added markdown documentation

Browse source
This commit is contained in:
Jake Howard 2017-05-10 20:09:10 +01:00
parent 73eb9df7a8
commit a6931517ac
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/markdown.md Normal file
View file

@ -0,0 +1,14 @@
# Markdown
Whilst `md-pdf` theoretically supports all formats pandoc does, it's only been tested and and validated to support markdown.
Information about markdown as a format can be found [here](http://daringfireball.net/projects/markdown/). The standard format and syntax is used, however there are some additional features to improve the output format.
### Images
Images take the same syntax as with standard markdown:
![title](url)
Referencing files inside your project directory can be done with a path relative to the project directory. You can use images direct from online, however you'll need to be connected to the internet when generating.
The title for the image is also used as the caption, and is displayed directly under the images.