From a6931517ac4d446e262204c58b28c7ecb62ea9ec Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Wed, 10 May 2017 20:09:10 +0100 Subject: [PATCH] Added markdown documentation --- docs/markdown.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/markdown.md diff --git a/docs/markdown.md b/docs/markdown.md new file mode 100644 index 0000000..46d456d --- /dev/null +++ b/docs/markdown.md @@ -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.