Markdeep Clone

This is an unofficial un-minified version of markdeep.mini.js.

As of 0.10 (2016-03-22), releases are signed with Minisign.

Minisign is a ‘dead simple tool to sign files and verify signatures’. Signed files will be accompanied by a corresponding *.minisig file.

You can verify the signature using my Minisign public key:

minisign -Vm <file> -P RWSmY4o5Bad1vS60aYAiQUswWYVV2EuSdqc3ry7CWWF1E6bVbFG9kR/y

Markdeep is a technology for writing plain text documents that will look good in any web browser. It supports diagrams, common styling conventions, and equations as extensions of Markdown syntax.

Markdeep is free and easy to use. It doesn't need a plugin, or Internet connection. There's nothing to install. Just start writing in Vi, Nodepad, Emacs, Visual Studio, Atom, or another editor! You don't have to export, compile, or otherwise process your document.

Markdeep is ideal for design documents, specifications, README files, code documentation, lab reports, and technical web pages. Because the source is plain text, Markdeep works well with software development toolchains.

Markdeep was created by Morgan McGuire at Casual Effects with inspiration from John Gruber's Markdown. The current minified-only beta release is public in order to find bugs and get feedback, but a full and stable version with natural source is coming soon after some more code cleanup.

Style Features

Unique features:

Diagrams
Title formatting
CSS stylable
Title and subtitle detection
Section numbering
Equation typesetting and numbering
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 or Internet access

Plus, best-of-breed Maruku Markdown features:

Tables
Paragraph formatting
Automatic e-mail address and URL linking
Nested, numbered and bulleted lists
Fenced code blocks
Bold, italic, code, strikethrough
Hyperlinks
Blockquotes
Images
Doesn't italicize math with * or words containing underscores
Unicode
HTML passthrough
Optionally process server-side or offline in Node.js

Get Started

To create a Markdeep document, just open any 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.

<style class="fallback">body{white-space:pre;font-family:monospace}</style><script src="markdeep.min.js"></script><script src="http://casual-effects.com/markdeep/latest/markdeep.min.js"></script>

You can drag your document into a web browser or double click on it to see it with formatting. You can also read the document in a browser when you don't have an Internet connection. If you want to avoid losing formatting when offline, just keep markdeep.min.js in the same folder.

View the plain source of the feature demo to learn the formatting styles that you can use. Markdeep extends Markdown, and to quote John Gruber:

The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions. To inspect the original text source for a Markdeep document in a browser, just add ?noformat to the end of its URL.

Origin and Credits

I created Markdeep because I was no longer willing to choose between design documents that looked good and those that worked well with programming tools. I liked what Mark_down_ did on web servers, so I used that as a starting point and added more styling features and a way to directly view the documents client side in a browser.

HTML is "mark_up_" that extends plain text with formatting. Unfortunately, the formatting tags often make original document source hard to read and write. This is slow and annoying, especially for those of us who use programming tools for document editing or want formatting in documentation files.

John Gruber invented Markdown to address HTML's editing problems. The name "mark**down" conveys styling in the opposite direction of the "markup**" tag syntax. Markdown beautifies text without explicit tags, based on common practices from ASCII e-mail and plain-text documents

"Mark_deep" is farther "down" from "markdown_" on the autostyling and beautification path. Markdeep combines an easy-to-use and browser-friendly packaging with new unique features for diagrams. The code includes some of the best previous Javascript document formatting libraries and links to MathJax for equation typesetting

Markdeep was created by Morgan McGuire. It extends the work of:

John Grubber's original Markdown concept and specification
Ben Hollis' Maruku (aka "Githib") Markdown dialect specification
Michel Fortin's Extra Markdown dialect specification
Dominic Baggott's markdown.js implementation for table and list processing
Ivan Sagalaev's highlight.js for syntax coloring
Contributors to the above open source projects

License

Markdeep is open source. You may use, extend, and redistribute Markdeep without charge under the terms of the BSD license:

      Copyright 2015, Morgan McGuire
      All rights reserved.

      Redistribution and use in source and binary forms,
      with or without modification, are permitted provided that the
      following conditions are met:

      1. Redistributions of source code must retain the above
      copyright notice, this list of conditions and the following
      disclaimer.

      2. Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.

      THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
      CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
      DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
      CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
      SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
      LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
      USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
      AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
      LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
      IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
      THE POSSIBILITY OF SUCH DAMAGE.

Markdeep includes markdown.js, so you are also bound by the MIT license (which is BSD-compatible):

      Permission is hereby granted, free of charge, to any person
      obtaining a copy of this software and associated documentation
      files (the "Software"), to deal in the Software without
      restriction, including without limitation the rights to use,
      copy, modify, merge, publish, distribute, sublicense, and/or
      sell copies of the Software, and to permit persons to whom the
      Software is furnished to do so, subject to the following
      conditions:

      The above copyright notice and this permission notice shall be
      included in all copies or substantial portions of the Software.

      THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
      EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
      OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
      NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
      HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
      WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
      FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
      OTHER DEALINGS IN THE SOFTWARE.

...and the highlight.js BSD license:

      Copyright (c) 2006, Ivan Sagalaev
      All rights reserved.

      Redistribution and use in source and binary forms, with or
      without modification, are permitted provided that the following
      conditions are met:

      * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
      * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
      * Neither the name of highlight.js nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

      THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS
      IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
      LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
      FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
      SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
      DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
      SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
      BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
      LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
      (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
      THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
      SUCH DAMAGE.

Release History

Starting in November 2015, old releases will be archived as

http://casual-effects.com/markdeep/_VERSION_/markdeep.min.js

You can modify the Markdeep line at the bottom of a document to hardcode to a specific version instead of the default version of "latest".

You can report bugs to morgan@casual-effects.com by sending a Markdeep document and what you think is wrong about the way that it appears.

2016-06-28 Version 0.12: Localization
1. Prevented double underscores in variable names inside of diagrams, e.g., __FILE__, from being parsed as lines
2. Prevented decoration characters from being stripped from diagrams when on false-diagonal lines composed entirely of decorations
3. Matched fixed-width fonts between diagrams and code blocks, and code block font sizes across platforms
4. Added localization support via markdeepOptions.lang and <meta lang="..." ...>
5. Increased robustness of section links
6. Added unnumbered sections using (#)
2016-05-14 STANDBY Morgan erased /0.11/markdeep.min.js from his server. Wish he used version control.
2016-05-06 Version 0.11: Integration
1. Added ?export option to extract raw HTML
2. Switched to font-rendering: antialiased; for lighter fonts
3. Added support for numeric exponents outside of math mode
4. Made spaces in figure/listing/table references unbreakable
5. Fixed processing of max-width and width on images
6. Added default max-width of 100% on images (can be overriden per image)
7. Extended minus-sign beautification to negative numbers immediately following an open parenthesis
8. Tweaked code syntax highlighting
9. Updated to use highlight.js 0.9.3
10. Fixed smart quotes after numbers
11. Made fancy quotes fully CSS-stylable
12. Made diagrams CSS-stylable
13. Protected style tags
14. Protected table of contents link names
15. Fixed long table of contents link to first section
17. Added gravizo support
2016-03-22 Version 0.10: Calendars and Images
1. Fixed alignment in table cells
2. Added support for links with no text
3. Added starter.md.html to web page
4. Switched default raw URL font to Georgia for more weight and better slashes
5. Table of contents now becomes its own section if it is longer than the abstract
6. Added support for Latex equation, eqnarray, and equation* environments
7. Fixed current-day highlighting on calendars
8. Fixed multiple single-$ Latex expressions on a single line
9. Allowed definition list terms to begin with non-word characters
10. Added support for daylight saving time independent of country
11. Improved robustness of parsing links within image captions
12. Added support for floating, captioned images
13. Fixed centering of multiple images in separate blocks
14. Allowed definition lists to have a single space between the colon and definition
2016-02-02 Version 0.09: References and Internal Links
1. Added support for schedule lists
2. 10x performance increase over version 0.08
3. Added IE11 support
4. Added support for calendars
5. Added support for HTML attributes on images
6. Added support for video
7. Added CSS classes for different list bullets
8. Added support for Youtube and Vimeo video
9. Fixed multiple centered images in a group
10. Fixed multiple colons in schedule event titles
11. Added fancy quotes
12. Highlighted current day on calendars
2016-01-18 Version 0.08: References and Internal Links
1. Prevented HTML tags in the title from appearing in the browser tab
2. Fixed single-character bold and italic text hanging across lines
3. Fixed indented bold and italic text crossing lines
4. Added reference-style links
5. Added footnotes/endnotes
6. Added citations
7. Allowed code blocks within other formatting
8. Code blocks can now contain diagram syntax without it becoming a diagram
9. Optimized performance of documents with many blocks
10. Updated Markdeep line hides the document until formatting succeeds or loading markdeep.js times out
11. Added smart quotes for double quotation marks
12. Fixed strict mode for Firefox
13. Protected raw <code> blocks from processing
14. Added automatic section links
15. Added table and listing captions
16. Added figure, table, and listing numbering and references
17. Fixed single-letter italic words in lists
18. Allowed lists to omit the leading blank line if the previous line ends in a colon or comma
19. Allowed inline code to wrap around a line
20. Stylized ~~~~code blocks appropriately for listings, while leaving ```` blocks unadorned
21. Fixed URLs with underscores and tildes
22. Added robust processing of lists with inconsistent indenting
23. Added support for lists within definition lists
24. Fixed definition lists with multiple :-indented lines
25. Added support for multiple paragraphs in definition lists
26. Added support for multiple paragraphs in regular lists
2015-12-31 Version 0.07: Polish
1. Fixed white dot decorations next to lines in diagrams
2. Fixed floating images (broken in 0.06)
3. Fixed diagonal up-left arrows not reaching boxes
4. Added support for captionless images
5. Added captions below images
6. Added support for centered images
7. Fixed processing of tables with short delimiters
8. Fixed diagonals appearing inside curves with vertices in diagrams
9. Allowed points vertically and horizontally adjacent to lines and points in diagrams
10. Improved unicode line and box character appearance in diagrams
11. Allowed leading space and shorter lines for Setext-style headers
12. Added Unicode block character support for diagrams
13. Enlarged Unicode hexagons to form tighter grids
14. Text is now selectable in diagrams
15. Added tiny grid examples to features.md.html
16. Added dot grid examples to features.md.html
17. Added Unicode examples to features.md.html
18. Added beautification of a number followed by "degrees"
19. Single linebreaks now allowed in italics, bold, and strikethrough
20. Hid the document until formatting is complete, once it is known that the script is available
21. Increased spacing between section numbers and titles
2015-11-30 Version 0.06: Bug Fixes
1. Improved arrowheads at points
2. Improved arrowheads at boxes
3. Improved processing of words with 'o' in boxes
4. Script tag workaround for C++ template/Java generic syntax in code examples with capitalized classes
5. Fixed blocks beginning at the top of the document
6. Allow LaTeX expressions at the end of a sentence
7. Relaxed whitespace rules for LaTeX expressions
8. Fixed URLs in subtitles
9. Centered diagrams by default
10. Switched to https by default for Markdeep and Mathjax
2015-11-10 Version 0.05: Beta
1. Added named anchors to all sections
2. Fixed $$ in code blocks
3. Fixed header on the first line of a document
4. Added table of contents generation
5. Adjusted link styling
6. Added markdeepOptions.detectMath
7. Fixed ==> arrows in html mode
8. Released implementation source code
2015-10-27 Version 0.04: Optimization
1. Reduced minified script size to 56k (v0.03 was 88k)
2. Added notes about Unicode source
3. En dash (--), em dash (---), and minus sign
4. Transform x into × in cases such as "1920×1080"
5. Fixed e-mail addresses in subtitles
6. Fixed arrows in the middle of lines not appearing
7. Removed borders around diagrams in the default stylesheet
8. Made tables centered in the default stylesheet
9. Added support for left floating diagrams
2015-10-21 Version 0.03: Embedding Support
1. Improved handling of underscore lines and parentheses in diagrams
2. Added support for short verticals in diagrams, e.g., _.- -._
3. Added support for hyperlinking of URLs containing ? and &
4. Added CSS class support for <em> and <strong> tags to allow reinterpretation of em vs. em syntax.
5. Fixed single quotes and dollar signs in fenced code blocks
2015-10-18 Version 0.02: Conformance
1. Reduced minified script size by 1k (to 83k)
2. Added support for as a list bullet
3. Explicitly protected script and style blocks (CommonMark)
4. No longer allow spaces between flanking bold and italic delimiter runs and enclosed words (CommonMark)
5. Switched to <em> and &emstrong> tags from explicit italic and bold ones
2015-10-15 Version 0.01: Initial release

mkhoeini / markdeep