[Rfc-markdown] using markdown for XML2RFC v3 I-Ds

Miek Gieben <miek@miek.nl> Thu, 04 December 2014 07:29 UTC

Return-Path: <miek@miek.nl>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (ietfa.amsl.com [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 54A621A0024 for <rfc-markdown@ietfa.amsl.com>; Wed, 3 Dec 2014 23:29:41 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: 1.821
X-Spam-Level: *
X-Spam-Status: No, score=1.821 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, FM_FORGED_GMAIL=0.622, FSL_HELO_FAKE=3.799, RCVD_IN_DNSWL_LOW=-0.7] autolearn=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 3Qx0m3c9KPzR for <rfc-markdown@ietfa.amsl.com>; Wed, 3 Dec 2014 23:29:40 -0800 (PST)
Received: from mail-wi0-f176.google.com (mail-wi0-f176.google.com [209.85.212.176]) (using TLSv1 with cipher ECDHE-RSA-RC4-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 182A41A880E for <rfc-markdown@ietf.org>; Wed, 3 Dec 2014 23:29:37 -0800 (PST)
Received: by mail-wi0-f176.google.com with SMTP id ex7so33705897wid.15 for <rfc-markdown@ietf.org>; Wed, 03 Dec 2014 23:29:35 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:resent-from:resent-date:resent-message-id :resent-to:date:from:to:subject:message-id:mime-version:content-type :content-disposition:user-agent; bh=a8kCdouJn5mFHW8rl6Nt2pfcHjK6SUaq8UYYLROFYWk=; b=dMep0LnnbuPk/TFpSbo2xWHLiv2zYPcAPJsWl8Xjy6OHmlDaBYECbCEix0sW2rqalW r6DLs/aS1Ycx6lMoxmV73Bb0U0sRzJJR0yRBtqAYKZIH1udTsbz4k83OfCQ6JR+ZQSS7 Nmfn6rImOKermOv3PavZzEFmteN4mh9FkiTMAisRX5LqnRfbEkSJ8IecGmsThjW4a8R3 D8mq019Hess3I3lIBNzPwx+5O985bWPlbZbNIxfziwXW0q5fkQ+KXzF1LC1A8bGinhxe 7+CRSn92laisjeYaIqPYV4jCLOp3OdGF2vNlRtJe1CT+fTI2Ye7Y8WFhbe/mbLozieq8 QecQ==
X-Gm-Message-State: ALoCoQmls/ObnGlKUWaC2vreVEeWT4Hw3qKY4ImB0nAVJEDQyXhGCU8mzJu7AyQfiJoJi8DQTB+e
X-Received: by 10.194.91.205 with SMTP id cg13mr8726028wjb.21.1417678175891; Wed, 03 Dec 2014 23:29:35 -0800 (PST)
Received: from gmail.com (c.8.b.b.5.5.4.6.0.3.b.8.1.4.9.7.f.3.c.4.9.5.f.b.0.b.8.0.1.0.0.2.ip6.arpa. [2001:8b0:bf59:4c3f:7941:8b30:6455:bb8c]) by mx.google.com with ESMTPSA id ce1sm39298981wjc.2.2014.12.03.23.29.35 for <rfc-markdown@ietf.org> (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Wed, 03 Dec 2014 23:29:35 -0800 (PST)
Resent-From: Miek Gieben <miek@miek.nl>
Resent-Date: Thu, 04 Dec 2014 07:29:34 +0000
Resent-Message-ID: <20141204072934.GA28422@gmail.com>
Resent-To: rfc-markdown@ietf.org
Received: from miek.nl (c.8.b.b.5.5.4.6.0.3.b.8.1.4.9.7.f.3.c.4.9.5.f.b.0.b.8.0.1.0.0.2.ip6.arpa. [2001:8b0:bf59:4c3f:7941:8b30:6455:bb8c]) by mx.google.com with ESMTPSA id wv8sm33537304wjc.44.2014.12.02.14.26.24 for <rfc-interest@rfc-editor.org> (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Tue, 02 Dec 2014 14:26:24 -0800 (PST)
Date: Tue, 02 Dec 2014 22:26:23 +0000
From: Miek Gieben <miek@miek.nl>
To: RFC Interest <rfc-interest@rfc-editor.org>
Message-ID: <20141202222623.GA15228@miek.nl>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"; format="flowed"
Content-Disposition: inline
User-Agent: Vim/Mutt/Linux
X-Home: http://www.miek.nl
Archived-At: http://mailarchive.ietf.org/arch/msg/rfc-markdown/IsNBamwURjYXQcbcjPvXx-dIork
Subject: [Rfc-markdown] using markdown for XML2RFC v3 I-Ds
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: "rfc-markdown is a discussion list for people writing I-Ds and RFCs in Markdown and the authors of the tools used for that." <rfc-markdown.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=unsubscribe>
List-Archive: <http://www.ietf.org/mail-archive/web/rfc-markdown/>
List-Post: <mailto:rfc-markdown@ietf.org>
List-Help: <mailto:rfc-markdown-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/rfc-markdown>, <mailto:rfc-markdown-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 04 Dec 2014 07:29:41 -0000

Hello,

I'm pondering a markdown syntax (mostly like CommonMark, but with a set of
extensions) for use when writing I-Ds for the XML2RFC v3 format. It steals
syntax from CommonMark, kramdown, leanpub and Asciidoc.

To play with it I've forked[1] blackfriday (a markdown converter written in
Golang), and implemented the following:

* TOML titleblock
* including other markdown files with the syntax: {{file}}
* indices with the syntax: (((Item, Subitem)))
* main-, middle- and backmatter document divisions, syntax: {mainmatter}, etc.
* citations, syntax: [@RFC223]
* reference section automatically created
* abstract, prefix paragraph with 'AB>'
* asides, prefix paragraph with 'A>'
* IAL, inline attribute lists from kramdown

It is a work-in-progress and the converter even still outputs some LaTeX blurbs.

A short example document can be found here:
https://raw.githubusercontent.com/miekg/blackfriday/master/ietf/ietf-markdown.md

Feedback welcome.

/Miek

[1]: https://github.com/miekg/blackfriday

--
Miek Gieben