menu

Markdeep

Markdeep is a free program that converts a Markdown file to HTML.

Overview

With Markdeep you can quickly convert your Markdown documents to HTML, and with that, view the file in any Web browser.

To use Markdeep you don't need to install anything, let alone register on any website.

The procedure is done by adding just one line of code at the end of your Markdown file.

If you need to quickly view a file in a Browser or even share the document for another user to analyze the output, Markdeep is the ideal tool for this task.

Let's understand how to convert the Markdown file to HTML using Markdeep.

  • First, add the code shown below to the end of your Markdown document.
    <!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://casual-effects.com/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>
  • Second, change the name of your file and add an html extension. For example, if your filename is file.md, rename it to file.md.html.
  • Third, load the file into a Web browser such as Google Chrome or Firefox.

Markdeep is quite generous in options for what you can do with your document. There are several templates for you to customize the appearance of your page converted to HTML; support for generating diagrams; presentation of LaTeX typography for mathematical equations and more.

You can find more information about Markdeep on the official tool website https://casual-effects.com/markdeep.

Markdown support on Markdeep

Table 1.1 shows the Markdown elements supported by Markdeep.

Element Support Information
Titles Yes
Paragraphs Yes
Line breaks No
Bold Partial Two asterisks in the middle of the content will be rendered literally, that is, it does not work: Lorem**ipsum**dolor.
Italic Partial Using an asterisk to format in italics in the middle of the word will result in literal rendering, meaning it does not work: Lorem*ipsum*dolor
Blockquote Yes
Ordered lists Yes
Unordered lists Yes
Code Yes
Horizontal lines Yes
Links Yes
Images Yes
Tables Yes
Fenced code blocks Yes Markdeep supports syntax highlighting.
Footnotes Yes
Title Id No
Definition lists Yes
Strikethrough Yes
Task lists Yes
Emoji (copy and paste) Unknown
Emoji (access codes) Unknown
automatic URL Link Yes
Disable automatic link from URL Yes
HTML Yes

See also

Markdeep Documentation