Which file types are supported?
- Markdown files (text) with one of the following extensions - .markdown, .mdown, .mkdn, .md, .mkd, or .mdwn. Technically, file extensions are not necessary but they exists to prevent accidentally uploading wrong type of file. If you use an extension which is not listed here contact me to add it.
- .zip, .tgz, .tar.gz compressed archives. This is to support images references by the markdown file. See, the next question for more details.
How to provide images referenced in markdown file?
There are two ways to handle images:
- Create a compressed archive (.zip, .tgz, or .tar.gz) containing markdown file and any images referenced by it.
- Upload images to a server and reference images in the markdown file by their URL. Markdown2PDF will download images before generating PDF.
What to do if images appear too large in the PDF
You need to resize images so that they fit in a A4 size paper. Alternatively, you can specify images using HTML img
tag as follows:
<img src="foo.png" alt="Foo" style="width: 500px;"/>.
Note that it is perfectly legitimate to use HTML tags in a markdown document as markdown is simply a super set of HTML (Daring Fireball: Markdown Syntax Documentation
Are any new features in the pipeline?
Yes! The support for custom CSS for the markdown and/or syntax highlighting is coming up soon. Also, I am planning to expose some of the internal variables for finer control on how PDF is generated.
What are the known bugs?
- If lines are too long in the code block they are not wrapped as expected but instead overflow out the page.