Skip Navigation

Markdeep

Description

It allows you to use an existing Markdown document, and make it pretty and viewable with formatting straight out of the box straight in a web browser, no fancy viewer or convertion required.

How to use it

Simply place the following string at the bottom of your .md file

<!-- 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://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>

and then append .html to the file extension (ex: file.md.html)

You can them open it with any web browser and view it with a table of content, clickable links, etc.

Why ?

It makes it quite simple to deploy as a static HTML file, and you can leverage the Markdown syntax for its readability if you need to edit it.

License

BSD-2-Clause

0
0 comments