text/markdown Use Cases
draft-seantek-text-markdown-use-cases-00

The information below is for an old version of the document
Document Type Active Internet-Draft (individual)
Last updated 2014-10-17
Replaced by RFC 7764, RFC 7764
Stream (None)
Intended RFC status (None)
Formats pdf htmlized (tools) htmlized bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                         S. Leonard
Internet-Draft                                             Penango, Inc.
Intended Status: Informational                          October 17, 2014
Expires: April 20, 2015                                                 

                        text/markdown Use Cases
                draft-seantek-text-markdown-use-cases-00

Abstract

   This document elaborates upon the text/markdown media type for use
   with Markdown, a family of plain text formatting syntaxes that
   optionally can be converted to formal markup languages such as HTML.
   Background information, local storage strategies, and additional
   syntax registrations are supplied.

Status of this Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

Copyright Notice

   Copyright (c) 2014 IETF Trust and the persons identified as the
   document authors. All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document. Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.

Table of Contents

   1.  Dive Into Markdown . . . . . . . . . . . . . . . . . . . . . .  2
 

Leonard                   Exp. April 20, 2015                   [Page 1]
Internet-Draft          text/markdown Use Cases             October 2014

     1.1. On Formats  . . . . . . . . . . . . . . . . . . . . . . . .  2
     1.2. Markdown Design Philosophy  . . . . . . . . . . . . . . . .  4
     1.3. Uses of Markdown  . . . . . . . . . . . . . . . . . . . . .  5
     1.4. Uses of Labeling Markdown Content as text/markdown  . . . .  5
   2.  Strategies for Preserving Media Type and Parameters  . . . . .  6
     2.1. Map to Attributes . . . . . . . . . . . . . . . . . . . . .  6
     2.2. Store Headers in Adjacent File  . . . . . . . . . . . . . .  6
     2.3. "Arm" Content with MIME Headers . . . . . . . . . . . . . .  7
     2.4. Create a Local Batch Script . . . . . . . . . . . . . . . .  7
     2.5. Process the Markdown  . . . . . . . . . . . . . . . . . . .  7
     2.6. Rely on Context . . . . . . . . . . . . . . . . . . . . . .  7
   3.  Registration Templates for Common Markdown Syntaxes  . . . . .  8
     3.1. MultiMarkdown . . . . . . . . . . . . . . . . . . . . . . .  8
     3.2. GitHub Flavored Markdown  . . . . . . . . . . . . . . . . . 10
     3.3. Pandoc  . . . . . . . . . . . . . . . . . . . . . . . . . . 11
     3.4. Fountain (Fountain.io)  . . . . . . . . . . . . . . . . . . 14
     3.5. CommonMark  . . . . . . . . . . . . . . . . . . . . . . . . 15
     3.6. kramdown-rfc2629 (Markdown for RFCs)  . . . . . . . . . . . 16
     3.7. rfc7328 (Pandoc2rfc)  . . . . . . . . . . . . . . . . . . . 17
   4.  Examples for Common Markdown Syntaxes  . . . . . . . . . . . . 17
     4.1. MultiMarkdown . . . . . . . . . . . . . . . . . . . . . . . 17
     4.2. GitHub Flavored Markdown  . . . . . . . . . . . . . . . . . 18
     4.3. Pandoc  . . . . . . . . . . . . . . . . . . . . . . . . . . 18
     4.4. Fountain (Fountain.io)  . . . . . . . . . . . . . . . . . . 18
     4.5. CommonMark  . . . . . . . . . . . . . . . . . . . . . . . . 18
     4.6. kramdown-rfc2629 (Markdown for RFCs)  . . . . . . . . . . . 18
     4.7. rfc7328 (Pandoc2rfc)  . . . . . . . . . . . . . . . . . . . 18
   5.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . 18
   6. Security Considerations . . . . . . . . . . . . . . . . . . . . 18
   7. References  . . . . . . . . . . . . . . . . . . . . . . . . . . 18
     7.1. Normative References  . . . . . . . . . . . . . . . . . . . 18
     7.2. Informative References  . . . . . . . . . . . . . . . . . . 18
   Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 20

1.  Dive Into Markdown

   This document serves as an informational companion to [MDMTREG], the
   text/markdown media type registration. It should be considered
   jointly with [MDMTREG].

         "Sometimes the truth of a thing is not so much in the
         think of it, but in the feel of it." --Stanley Kubrick

1.1. On Formats

   In computer systems, textual data is stored and processed using a
Show full document text