Amazing client side markdown
with zero installation. [](templates/starter/starter.md.html download class=no-icon) **Markdeep** docs look like a PDF in a browser and work like native ASCII docs in your editor. There's no plugin, exporting, or server. It supports every operating system and editor. Markdeep supports style sheets, diagrams, calendars, citations, equations, and more, plus all common markdown features. It seamlessly integrates with your entire text-mode toolchain: IDE code editor, version control, GitHub, Jira, browser, terminal/CLI tools, and agentic tools. You can read locally as `file://` or `http://localhost`, and host online with both static (like `github.io`) and dynamic servers. Markdeep is free and easy to use. Your data is 100% private and your document never leaves your own computer for local reading. You can load Markdeep itself from CDN or store it locally to run completely offline. Here's an example of a text editor and a browser viewing the *same file* simultaneously, showing the magic:

Text Editor

example.md.html

Browser

Example

# Features Markdeep supports Maruku + github + Admonition + CommonMark markdown syntax and extends them with many unique features. See the [demo](demodoc.md.html)!

Unique Markdeep Features:	Markdeep Standard Feature Support:
- Diagrams - Insert documents into one another - LaTeX equation typesetting and numbering - Table of contents - Reference images and embedded images - Document title and subtitle formatting - Schedules and calendars - Section numbering and references - Figure, listing, and table numbering and references - Smart quotes - Embedded video - CSS stylesheets - Page breaks - En dash, em dash, ×, minus, and degrees - Attributes on links - Unindexed sections - Works in any browser by adding one line to the bottom of a text document - Fallback to ASCII in a browser if you have neither the local file nor Internet access - Optionally process server-side with `node.js` - Optionally batch process to PDF with headless browser flags - HTML export to static content using `?export` in the URL or "[Rasterizer](https://github.com/romainguy/markdeep-rasterizer)"	- Tables - Paragraph formatting - Automatic e-mail address and URL linking - Nested, numbered and bulleted lists - Fenced code blocks - Section headers - Links and reference links - Task lists - Bold, italic, code, strikethrough - Hyperlinks - Attributes on images - Blockquotes - Citations - Footnotes and endnotes - Definition lists - Images - Doesn't italicize math with * or words containing underscores - Unicode - Admonitions (callout notes) - HTML passthrough

Unique Markdeep Features:

Markdeep Standard Feature Support:

- Diagrams - Insert documents into one another - LaTeX equation typesetting and numbering - Table of contents - Reference images and embedded images - Document title and subtitle formatting - Schedules and calendars - Section numbering and references - Figure, listing, and table numbering and references - Smart quotes - Embedded video - CSS stylesheets - Page breaks - En dash, em dash, ×, minus, and degrees - Attributes on links - Unindexed sections - Works in any browser by adding one line to the bottom of a text document - Fallback to ASCII in a browser if you have neither the local file nor Internet access - Optionally process server-side with `node.js` - Optionally batch process to PDF with headless browser flags - HTML export to static content using `?export` in the URL or "[Rasterizer](https://github.com/romainguy/markdeep-rasterizer)"

- Tables - Paragraph formatting - Automatic e-mail address and URL linking - Nested, numbered and bulleted lists - Fenced code blocks - Section headers - Links and reference links - Task lists - Bold, italic, code, strikethrough - Hyperlinks - Attributes on images - Blockquotes - Citations - Footnotes and endnotes - Definition lists - Images - Doesn't italicize math with * or words containing underscores - Unicode - Admonitions (callout notes) - HTML passthrough

# Quick Start To create a Markdeep document, just **download a [template](templates.md.html)** and start editing as markdown in any text or code editor. That's it! Double click to view in your web browser. ------------------------------------------------------------- You can change templates at any time by adding a style sheet to the final line of the document, or make your own per-document or per-site stylesheet. Every aspect of the presentation is customizable using built-in options, CSS style sheets, and even JavaScript extensions. If you like to start from scratch with no download or convert an existing markdown file to Markdeep, just open a text editor and start writing. Paste the following at the bottom of your document as a single line. Then, save it as plain text with a filename with extension `.md.html`. ``` none <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> ``` Markdeep supports ASCII source by default. To enable full Unicode support, put the following line at the *top* of the document: ``` none <meta charset="utf-8"> ``` You can read the document in a browser even when offline. If you want to avoid losing formatting when offline, just keep [markdeep.min.js](markdeep.min.js) in the same folder as your document. # Examples **Who uses Markdeep?** Everyone! It is popular within the technology industry and academia as an internal productivity tool, as well as a document sharing format. Some prominent uses online include:

- [McGill University](https://cim.mcgill.ca/~derek/ecse343.html) - [Boxxd](https://www.boxxd.org/packages/util-markdeep-js-en.v1/) - [University of Waterloo](https://morgan3d.github.io/advanced-ray-tracing-course/index.html) - [Google](https://google.github.io/filament/Filament.md.html) - [NVIDIA](https://github.com/nvpro-samples/vk_raytracing_tutorial_KHR/tree/master/docs) - [Dassault Systèmes](https://dassaultsystemes-technology.github.io/EnterprisePBRShadingModel/user_guide.md.html) - [Williams College](https://www.cs.williams.edu/~morgan/cs107-s17/) - [Universität Tübingen](https://github.com/doersino/markdeep-thesis) - [quadplay](https://morgan3d.github.io/quadplay/doc/manual.md.html) - [Graphics Codex](https://graphicscodex.com/projects/rays/index.html) - [fxis.ai](https://fxis.ai/edu/how-to-use-markdeep-a-markdeep-official-guide/) - [Imaginary Institute](https://imaginary-institute.com/resources/MarkdeepToInDesign/MD-ID-notes.md.html)

Daily todo lists and notes, README files, creative writing, manuals, websites (including this one), theses, presentations, and even whole textbooks are powered by Markdeep. Here are some more examples to inspire your creativity: - [API doc](https://morgan3d.github.io/quadplay/doc/manual.md.html) - [Syllabus](https://www.cs.williams.edu/~morgan/cs371-f16/?) - [Game design document](http://casual-effects.com/gamejam/babybat/index.html) - [Homework assignment](http://graphicscodex.com/projects/rays/index.html) - [Lecture slides](http://db.inf.uni-tuebingen.de/staticfiles/teaching/ss17/advanced-sql/slides/advanced-sql-00.pdf) - [Software library website](https://morgan3d.github.io/include.js/) - [Game report](http://casual-effects.com/gamejam/topburn/index.html) - [Blog 1](http://momentsingraphics.de/), [Blog 2](https://morgan3d.github.io/articles/2019-04-08-first-vr/) - [Curriculum Vitae (Resume)](https://casual-effects.com/morgan/cv.md.html) - [Thesis](https://github.com/doersino/markdeep-thesis) - [Guitar chord diagrams](https://morgan3d.github.io/articles/music/chords.html)