Markdeep – plain text documents with diagrams, equations, and Markdown syntax, Hacker News

              Markdeep
        

✒

      

         

✒

    

Demo Features Templates Get Started Examples Advanced Credits License     

       Markdeep is a technology for writing plain text documents that will look good in       any web browser, whether local or remote. It supports diagrams, calendars, equations, and other features as       extensions of Markdown syntax.     

    

      Markdeep is free and easy to use. It does not require a plugin or internet       connection. Your document never leaves your machine and there’s nothing to install. Just       start writing in your favorite text editor. You don’t       have to export, compile, or otherwise process your document. Here’s an example of a text       editor and a browser viewing the same file       simultaneously:     

         

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

    

      Markdeep was created by Morgan McGuire       ( Casual Effects ) with       inspiration from John       Gruber’s Markdown       and Donald Knuth’s and Leslie Lamport’s LaTeX .     

              (See the demo !)     

      Unique features:       

(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             Maruku github Admonition CommonMark Markdown features:        (Tables)          Paragraph formatting          Automatic e-mail address and URL linking          Nested, numbered and bulleted lists
           Fenced code blocks          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                 

         

      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 .          

  body {visibility: hidden; white-space: pre; font-family: monospace}

      

        If you wish to use Unicode characters in your source document,       you must put the following line at the top :     

      

      

        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.                Markdown Modes for Popular Editors      (Visual Studio Code provides built- in Markdown support          (Visual Studio)
•          (Emacs)
•          Vi          (Sublime)
•          (Notepad )          Atom provides built-in Markdown support ; see below for enabling it
•       

        For Markdeep Markdown Atom support, press Ctrl Alt P to open the Command Palette. Type “open your config” and then       click on the result. This will edit your

• config.cson file. Add the following entry:        “*”:     core:         customFileTypes:             “source.gfm”: [“md.html”, “md”]       

             
         For Markdeep   Markdown Emacs installation, save  
   markdown-mode.el 
    in       
   ~ / emacs.d / 
   and add the following lines to       your  ~ / .emacs  file:          ;; Uncomment the following line on OS X ;; (add-to-list 'load-path (expand-file-name "~ / .emacs.d"))  (autoload 'markdown-mode "markdown-mode" "Major mode for editing Markdown" t) (add-to-list 'auto-mode-alist' ("\. md.html \ '". markdown-mode) (add-to-list 'auto-mode-alist' ("\. md \ '". markdown-mode))        

                 Diagram Tips     

        There are a lot of techniques that can make drawing diagrams in plain text easier. I just       use Visual Studio or Emacs in overwrite mode, and do everything by hand. I find that much       easier than installing or learning a new tool. Here are some basic editor tricks:       

  In most editors, pressing the insert key will enter         overwrite mode, where you can type without inserting. If         You’re on a Macbook in Bootcamp, press

• fn         return
• for insert. Or, in Emacs, use
• M-x         overwrite-mode toggle overwriting.         
• In Visual Studio, hold down Alt while selecting to make a         selection rectangle. This allows you to insert, type, and         delete across multiple lines.         
• In Emacs, you can define a macro on the fly           with (Cx) , some key strokes, and           then
• Cx) . Press Cx e to play           back the macro, and keep repeating
• e to keep           executing it. I use this to eliminate the manual work of           repetitive actions, for example, adding a space on the left           of an object and deleting one on its right to shift the           object right.             Others prefer more sophisticated options:               Overwrite-mode, Artist-mode, or Picture-mode in Emacs. These are minor modes that you can toggle on top of your major (language) mode.
•          Vim DrawIt!          ASCIIFlow Infinity is a free web tool for drawing ASCII diagrams.
          
  • Org-mode is a major mode in Emacs for ... everything. Markdeep diagrams are largely compatibile with its ditaa diagram syntax.          Asciio is a standalone tool.
  •          JavE is a standalone diagram tool, but its syntax isn't entirely compatible with Markdeep.         
  • The Unix tool groff has an interpreter for the Pic , which can be used to generate diagrams from graphs.          graph-easy can convert Dot and other graph languages ​​to ASCII.
  •          Monodraw is an OS X Unicode art editor that can produce Markdeep diagrams, but you should avoid using non-ISO - 1 (Latin 1) characters, since they won ' t produce lines.          FIGlet will convert text to ASCII art banners. Some of its fonts are Markdeep compatible.             What about the "ASCII drawing characters," the DOS code page 1920       and 2016 characters? They're not widely supported in most modern       monospace fonts (and thus editors), which are keyed to       Unicode. Although Unicode has the same box drawing characters,       they're now at different code points and not well supported by       text-only tools (alas! I grew up with text-mode graphics and miss them).                    

          Markdeep is used extensively within the technology industry and academia. Manuals,       theses, and even whole books have been written in it. Here are some public examples by       myself and my colleagues:       

    API documentation          Syllabus

             Game design document          Homework assignment          Lecture slides          (Software library website          Game report

             (Blog 1) , (Blog 2)          Curriculum Vitae (Resume)          (Thesis)                  The following features are experimental and may change at any     time. See the (release history) for change information     between versions.      URL Arguments     

          You can add the following arguments to any Markdeep document URL to alter how it       is displayed. For example, http://foo.bar/index.md .html? export shows       the HTML output.       

    () (noformat)          Attempt to display the original source of the document. Due to web browser limitations,           in some cases this will not be (% accurate to the actual file source.)          (export          Make the displayed body HTML source code produced by Markdeep. This is useful           for exporting a Markdeep document to HTML if you need to paste it into some context,           such as an ePub book or Blog site, that does not allow scripts.         

           (Options)     

          Markdeep looks in the

    window.markdeepOptions object       to determine its behavior. The legal options are:        () (mode)          A String that can be:           

    'markdeep' - the default: process the document as Markdeep              'script'

    - do not modify the document              'html'

  - process the document as HTML with embedded Markdeep nodes              'doxygen' - process special tags in Doxygen documentation

                      (lang)          An Object describing the natural language to use for         keywords such as Section and Figure. (If your language         is already supported by Markdeep, it is much easier to set this         via a tag in the         document.) Look at the value of the global variable         

  • FRENCH in the source code to see the structure         of this Object.         
             tocStyle

           A String specifying the layout style for the table of contents. Values ​​are:           

  • 'auto' - Adjust based on the length of the document. (Default)              ('none') - Do not show a table of contents              'short' - Show a short table of level-1 headers on a line across the top of the document
                 ('medium') - Float a small-font full table of contents to the right of the abstract              ('long') - Insert a full table of contents in normal font size as the first section after the abstract                    
    scrollThreshold

                     A Number specifying the distance in pixels that the body can be scrolled before           the scrolled (class should be added to the (body) element.           This is useful for creating CSS styles for web page headers that present differently           when the document is first shown versus scrolled down to the contents. The default is .         

           definitionStyle

           A String specifying the layout style for definition lists. Values ​​are:           

  • 'auto'
  • - Adjust based on the longest definition in each list. (Default)              'short'

– Always format as a table, where definitions are in a column on the left.

             (‘long’) – Always format using a hanging indent, where the definitions are under the terms.                     hideEmptyWeekends

         A Boolean specifying whether the calendar views from schedule lists should remove           weekend days if there are no events on them. The default is true .

         detectMath

                   A Boolean that defaults to true

. If true,           when LaTeX math surrounded by $ ... $

,           

• (… ) , or begin {…} … end {…}           is encountered, the MathJax processor is automatically loaded           from their CDN. Set to
• false if you don’t use           math notation, host MathJax locally and include it using a           script tag yourself, or use an alternative math processor.         
           (showLabels)                    A Boolean that defaults to false

.           Display all labels for Figures, Listings, and Tables, as well as           URLs for images with captions, the document itself, and links. This is           useful when printing proofs of book chapters.         

        
sortScheduleLists

                   A Boolean that defaults to true

. Sort schedules           in order of increasing date, regardless of the order in which           events appear in the source document.         

         (captionAbove)                    A table mapping diagram , (image) ,

listing , and (table) to           Booleans. Each defaults to

false , meaning that captions appear below           (after) the objects. Set values ​​to true to move the captions above (before) the           objects. Example: markdeepOptions.captionAbove.listing=true . In the           Markdeep source document, captions must always appear after the object. This           Option only affects where they appear when the document is viewed.         

         (onLoad)                    Function invoked after Markdeep is done processing the document and the DOM is ready.         

         linkAPIDefinitions

                   Boolean that defaults to false . If true, inline code referencing a `variable`           or `function ()` is linked to a definition list that also uses inline code formatting           for that `variable` or` function (args ...) `. There can be no space between a function name           and the opening paren.         

       (Tables)     

You can use a

markdown table     generator to produce and edit the source for a table in Markdeep, since Markdeep is a     superset of CommonMark markdown.          
(Markdeep to PDF, EPUB, and HTML)     

      You can of course print Markdeep documents to PDF from your       browser manually. Markdeep reformats with some sensitivity to       page breaks and printing-specific layout when you do so. To       automate the process of generating PDF files from Markdeep, I       use Chrome in headless mode. For example:              

      # OS X:       
/ Applications / Google Chrome.app/Contents/MacOS/Google Chrome --headless --print-to-pdf=output.pdf input.md.html       

# Windows:       
C: Program Files Google Chrome Application chrome.exe --headless --print-to-pdf=output.pdf input.md.html       

# Linux:       
google-chrome --headless --print-to-pdf=output.pdf input.md.html              This will print some error messages but should also create the PDF correctly. The filename can be a raw OS-level filename, a

http or       

https protocol URL, or a (file) protocol URL. You may need to       host the markdeep.min.js script in the same directory as your content for       local files, depending on your browser and system configuration.          

      I previously used the wkhtmltopdf program for PDF generation this purpose, but its recent       versions do not work very well on OS X.     

    

      To force sections to begin new pages when printed or in a PDF, add the following       to your Markdeep document:       

.md h1, .md. nonumberh1 {page-break-before: always}

for generating books (including theses)       using Markdeep.          

      Under OS X, you can run join.py to multiple concatenate       Markdeep PDF chapters for a thesis or book with the single-line command:       

“/ System / Library / Automator / Combine PDF Pages.action / Contents / Resources / join.py” -o merged-file.pdf file1.pdf file2.pdf .. .          

      The

• The export option produces raw HTML export in a browser, which you can then manually copy or save.       For automated HTML export, see
  

      by Romain Guy.          
(Markdeep in HTML Documents)     

      By default, Markdeep passes HTML commands through to the       browser. This is for HTML in a primarily Markdeep document. If       You have a document that is instead primarily HTML and you want       to use Markdeep within it, then load the script with the following       code at the end of the document inside of the body tag:       

      
      This will process

• tags as Markdeep       (which may include embedded diagrams enclosed in       asterisks),
• tags as Markdeep       diagrams (which do not need enclosing asterisks), and leave any       other content in the document unmodified as HTML.          

        You can also use

• and        tags.          
       Markdeep with Doxygen      (One-Time Configuration)     

        Add the following to

• Doxyfile               HTML_FOOTER=footer.html       
EXAMPLE_PATH=markdeep-dir       
ALIASES="copy {1}= htmlonly endhtmlonly image html 1 n htmlonly endhtmlonly"       where markdeep-dir is the location of your optional Markdeep overview documentation       files relative to the
• Doxyfile . footer.html is your custom footer,       which must include the following lines:       

        
  

        Within API documentation, you can use and       

• tags to add Markdeep content. Regular markdown       will continue to be processed by Doxygen outside of those tags as well.           (Adding Documentation)     

        To insert pages of full Markdeep documents, without any Doxygen or comment syntax, use       the htmlinclude command.       To make Doxygen copy images referenced from your Markdeep documents to your documentation       output directory, use the copy command in any Doxygen file.     

      

        For example, to set your documentation main page to be Markdeep embedded within the Doxygen docs and       copy architecture.png , make a mainpage.dox

that contains:        / mainpage       
copy {architecture.png}       
htmlinclude mainpage.md.html /          
Javascript API     

      You can prevent Markdeep from autoformatting a document so that you can use it       as a Javascript library by loading it as:              

      
             This allows you to then manually invoke diagram processing or       full Markdeep processing from within your own Javascript       programs. Markdeep exports the following members on       

• window.markdeep :          

         function format (src, elementMode)       

          

            Converts a String or DOM Element containing Markdeep content           into a String of HTML that is returned. The result does not           include the Markdeep header (stylesheet and math library script           tags) or footer (signature line). The input is not modified.         

          

            Optional argument

• elementMode defaults to true,           which surpresses page titles and a table of contents.           Set elementMode=false
  if processing a whole           document at once. Section captions are unaffected by this           argument.                  
                

         function formatDiagram (str, alignment)       

          

            Converts a Markdeep diagram (without the surrounding asterisks)           to a String containing SVG HTML that is returned.         

          

             alignment is an optional String value for           the float

attribute of the SVG node. It may           be 'left'

, ('right') , or           

• undefined .                  
           

         function stylesheet ()       

          Returns the Markdeep default stylesheet used for short         documents. Markdeep adds extra spacing around the title         when formatting a large document.         
           
  (Code)     

        Markdeep is open source, so you can directly download and modify       the       source: markdeep.js Implementation       suggestions and patches are welcome       at [email protected] .       I'm particularly interested in suggestions for ways to       significantly reduce the (minified) script size further.     

      

        This was a small hobby project, so I don't provide technical       support and can't add every feature requested. However, so far       I've been able to fix all reported bugs within a few days and       often add features if they are straightforward and       well-specified. Fortunately, if I'm unable to add the change       that you want, you can just make those changes yourself.     

                

        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       conveys styling in the opposite direction of the       "mark up tag 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       "mark down on the autostyling and beautification       path. Markdeep combines an easy-to-use and browser-friendly       packaging with new unique features such as 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 design       and implementation work of:       

  (John Gruber's original) Markdown concept and specification          Ben Hollis' Maruku (aka "Github") Markdown dialect specification          Michel Fortin's (Extra) (Markdown dialect specification)          Ivan Sagalaev's (highlight.js) for syntax coloring

          
  • Contributors to the above open source projects                   Markdeep is open source. You may use, extend, and redistribute       Markdeep without charge under the terms of       the BSD       license :            Copyright 2019 - 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 highlight.js, so you are also bound by its BSD license:             Copyright (c) 2017, 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.     
                          
           Follow  @ CasualEffects        on Twitter for notification of new incremental features and       releases.     
         
           Old releases are archived as       
               
     https://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  [email protected]        by sending a Markdeep document and what you think is wrong       about the way that it appears.     
           - 10 - TBD Version 1. 16            (Improved)  interaction between Unicode box drawing characters and diagram patterns. 
    
                 
     Section context menu now includes visit and copy raw URL options. 
                  Section context menu now correctly includes the URL protocol.
                  Optimized processing of long documents that do not use (insert ... here features.
                  Added support for (insert ... here in html mode.
                 
    
     Footnoted words may now appear immediately before a colon beginning a lixt. 
                 - - (Version 1.)            (Improved)  mobile layout in portrait mode.
                 
    
     Added corporate API and whitepaper templates. 
                                  - - (Version 1.)            (Improved)  printing quality.
                  Added support for escaped backticks ( ` to prevent inline code processing.
                 
    
     Fixed floating images breaking paragraphs when placed at the middle or right (was always broken ). 
                 
     Fixed inline images with no captions floating right (broken in 1. 14). 
                 
     Right-click on a section header in the browser to copy link code for that section to the clipboard. 
                  Added the  Newsmag  template.
                 
    
     Added "chapter" as a synonym for "section" for auto-linking purposes . This will likely change in the future to work with multi-file documents               that store one chapter in each file.             
     Fixed all caption types to be centered blocks by default as originally intended. Left-aligned behavior applied to some captions               in previous versions can be restored with 
     . md .imagecaption, .md .tablecaption, .md .listingcaption {width: (%}
    
    
    
     . 
                  Upgraded to Mathjax 2.7.6. 
    
                  Added pyxlscript syntax highlighting for quadplay.              Fixed
     .md svg.diagram .opendot  to be solid white again.
                 
    
     Restricted image captions to at most five lines to eliminate some ambiguous parsing situations.             
     Optimized processing of documents with a large number of images and links.                              - - (Version 1.)            (linkAPIDefinitions) option for creating Doxygen-link internal links when writing code documentation.
                  Added support for multiple dimensions eg, (2 x 4 x 6) → 2 x 4 x 6. 
    
                  Footnote references that are not at the start of a line may now be immediately followed with a colon.
                  Moved table of contents to the left of the journal template for better scroll-bar placement.
                  Added resume and API examples.
                 
    
     Fixed multiple footnotes on the same line. 
                  Fixed HTML comments with no spaces.
                  Added support for image grids with unfilled final rows.
                                      - - version 1 . 12            Allow syntax highlighting to force a language even if the syntax appears illegal.
                  Added syntax highlighting in code blocks for YAML and nanoscript.
                  Added (definitionStyle) for controlling definition list layout.
                  Added (markdeepOptions.scrollThreshold) and
     .md body.scrolled for CSS to detect scrolling. 
    
                  Added
     tocTop 
    
     hidden link in the table of contents for CSS to expose for websites 
                  Added 
    
     website.md.html  template
                  Added slate.md.html  template
                  Added
     journal.md.html  template
                  Changed the default template to code blocks not wrapping, but forced the printed version to wrap so                  that nothing would be lost when converting to PDF or physical media.             
     Fixed a bug in the unicode points for gray characters. Now using U Full Block as the darkest .              Added Spanish localization by Marcelo Arroyo.              Added four new dot styles to diagrams using unicode circles: (◌-- ○ ◍-- ●)
                  Updated Swedish localization.              Added SQL and PyxScript to code highlighting.                     - - (Version 1.)            Added highlighting support for Go, Scheme, and Kotlin.
                  Made inline (code) not break within words. 
    
                  Added fully-qualified links to sections.
                  Made table of contents use fully-qualified mangled names instead of numbers.
                  (export mode now preserves newlines.
                  Added
     thetai 
    
    , 
     thetao , d {x} Latex macros. 
                  Improve printing scale and margins.
                 
    
     Equations can now be referenced with the same syntax used for tables, diagrams, listings , and figures. 
                  Automatically substitute replacements for Unicode characters in [dinosaur] that does not render correctly in browser tabs.
                 
    
     Fixed localization of month and day names.             
     Documented 
      Process anchor targets in the URL regardless of document load and layout delays.
                 
    
     Fixed a lockup bug in documents with obscure unicode characters. 
                 
     Stripped HTML escapes from header anchor names in links for more readable intra-document targets .             
     Fixed bug with multiple reference images in the same document.              Allowed captions on reference images.                     - 18 - (Version 1.)            (Documents how to add Atom support.
                 
    
     Added .webm video support. 
                  Improved Swedish localization.
                 
    
     Fixed mixed task / bullet / number lists. 
                  Permitted ATX-style headers with (#) in them.
                  Fixed trailing blank line in diagrams.
                  Added support for audio files using video link syntax.
                  Added optional line numbers on code listings.
                         - 16 - (Version 1.)            (Fixed) alignment of diagrams with no right border of
                   Fixed
     pagebreak 
    
     requiring other characters on the same line 
                  Added Czech localization by Jan Toušek             
    
     Added support for localized "section" appearing before or after a section title
                  Made reference link parsing more robust, allowing newlines within the text 
    
                  Added  github style task lists 
    
                 
    
     Fixed multiple  (insert ... here) (statements in a document               Made the apidoc.md.html  (sample not flash the raw source on load              
     Stripped links from section titles in the table of contents              Added support for reference images                                - - Version 1. 06: Feature Complete            (Fixed) use of  (include here)  with implicit email links.
                  Added Portuguese localization by Tiago Antão              Added Italian localization by Leonardo Taglialegne 
                 
     Fixed references not working for localized (figure) variants               Added support for Gravizo SVG format graphs             
     Removed browser header / footer when printing to PDF              Support for IE
                  Added Lithuanian localization by (Warmist)
                                      - 20 - (Version 0.) : Code            (Tw the  apidoc.css  style.
                 
    
     Fixed top-level header formatting broken in the previous release. 
                 
     Code blocks now use four-space tabs (instead of eight spaces). 
                 
     Added syntax coloring for Go, Rust, R, Lua, TypeScript, and Swift code blocks. 
                  Added support for back-to-back code blocks with no text between them.
                 
    
     Improved robustness of schedule list detection and removed warning messages from speculative parser. 
                 
     Localized smart quotation marks to the same region as other keywords, following this spec . 
                  Fixed email address detection for 2-letter domains with a patch by Michael Smirnov.
                                  - - (Version 0.) : Unification            Added support for long
     and -> 
    
     arrows in body text. 
                  Added support for ordered lists that begin with numbers other than 1.              Markdeep now strips HTML comments that are not in code blocks at the beginning of processing .
                  Added Japanese localization by Takashi Masuyama.
                  Added optional CSS classes to fenced code blocks.
                  Added multiple unioned code blocks for use in highlighting and multi-language examples.
                 
    
     Fixed CSS to not leak outside Markdeep blocks when in html embedding mode. 
                 
     Added support for LaTeX when in do oxygen and html embedding modes. 
                  Added admonitions (callout notes for the reader).
                  Added (apidoc.css) stylesheet and corresponding template by Aras Pranckevičius.
                         - 18 - (Version 0.) : Robustness            (Upgraded) to (highlight.js) (9.) . 0, included shell session highlighting.              Fixed excess whitespace due to tags being generated near section headers.
                  Capitalized "Contents" in English.              Made title and list pattern detection more robust.             
     Improved parsing of image grids when near other individual images. 
    
                 
     Made all images hyperlink to their full-resolution versions. 
                 
     Improved wide character support for diagrams contributed by Torsten Grust. 
                  Changed implicit URL parsing to consider a trailing period as punctuation instead of part of the URL.               Use explicit URL syntax of