You are here: [Home](../../../home.html) / [Help](../../help.en.html) / [Utilities](./index.html) / Utility Markdeep.js # Utility Markdeep.js ![](assets/markdeep-js-001-v01-892x462.png) The Markdeep.js is a javascript (js) that formats long Markdown plain text so that it can be read in a browser. It can: * add a Table of Contents * print ASCII art into nice graphics With the Markdeep.js utility it is easy to write _stylish_ documents in plain text ## Simply 1. Write a text document 2. Add the Markdeep line at the end 3. Save with file extension `.md.html` (so that you know later that it is a Markdown file) 4. Double-click to view ## Demos * [For an example of the formating](../demos/markdeep-js-features-demo.md.html) ## Formating To create diagrams etc from plain text, have a look at the plain text file of the demo, using *?noformat* on the end of the URL: [For an example of the formating](../demos/markdeep-js-features-demo.md.html?noformat) ## Creating a file If you use foreign languages or do special graphics you will need to add the following line at the beginning of your file: ` ` and to do the magic i.e. call the necessary script, add the following lines to the end of your file: ``` <!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js"></script><script src="https://casual-effects.com/markdeep/latest/markdeep.min.js"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>--> ``` For offline use, change the src path to the .wiring directory or if this is too complicated, copy the _markdeep.min.js_ from the _.wiring/lib/markdeep.js_ directory to your local directory and add the following lines to the end of your file. ``` <!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>--> ``` Or put your file in the Talk directory and copy the following lines to the end of your file: ``` <!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="../.wiring/lib/markdeep.js/markdeep.min.js"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>--> ``` ## Fall back If the js script is not available, the file will be readable in plain text. ## Resources to markdeep.js ### Boxxd _Scripts (for online use):_ * ### Others _Homepage:_ _Source:_