Home

This wiki contains the full documentation of md2book. If you haven't read the readme, it gives general informations about the project. To get started, first read the installation page, and next the quick start page.

Usage notes

• In the configuration, path relative to your home directory (~/some/path) do not work. Use absolute paths instead.
• The markdown and html documents generated are not completely portable, because they reference the fonts and images that are external files on your system.
• Generating pdf takes some time, this is the expected behaviour, because they are generated using webkit from the html document. You can generate the same pdf with the html file, and using print -> print to pdf in you browser.
• The docx and odt files generated do not support all styles and functionalities. Md2book is design to publish using pdf / ebook / html. Docx should be used to share a work-in-progress draft.
• Footnotes are placed at the end of the document.

Known issues

• LaTeX equations are not rendered inside docx / odt, because of the limitations of pandoc. They work well with html, pdf and ebooks
• Tables width in docx documents is too small (width of 1 character in each column)
• Custom fonts are not supported in docx and odt.
• odt documents have strange grey areas and are not well formated
• Problems with background color if the background is not white occurs in pdf and ebook. It is recommended to use a white / transparent background for better results in ebook.