Added markdown documentation
This commit is contained in:
parent
73eb9df7a8
commit
a6931517ac
1 changed files with 14 additions and 0 deletions
14
docs/markdown.md
Normal file
14
docs/markdown.md
Normal 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.
|
Reference in a new issue