IETF Logo Mail Archive

[Rfc-markdown] Am I missing any tools for markdown -> RFC?

Dan York <york@isoc.org> Sun, 10 June 2018 07:51 UTC

Return-Path: <york@isoc.org>
X-Original-To: rfc-markdown@ietfa.amsl.com
Delivered-To: rfc-markdown@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 38E58130E1E for <rfc-markdown@ietfa.amsl.com>; Sun, 10 Jun 2018 00:51:19 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2
X-Spam-Level:
X-Spam-Status: No, score=-2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=isoc.org
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 CLOp_LsyJgmw for <rfc-markdown@ietfa.amsl.com>; Sun, 10 Jun 2018 00:51:16 -0700 (PDT)
Received: from NAM03-CO1-obe.outbound.protection.outlook.com (mail-co1nam03on0622.outbound.protection.outlook.com [IPv6:2a01:111:f400:fe48::622]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 5FA11130DDA for <Rfc-markdown@ietf.org>; Sun, 10 Jun 2018 00:51:16 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=isoc.org; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=0VZ9Be1ZLLaGwlGECUoOtf3onK8MF/HAkJ94Mttsfmg=; b=k2/mhsdQlZQGoOWemWEWHBqi9RDtjs85V8MYZ4YIGUSPJtT74fFGV7MNoe69c7U/5GD/HnbYJtl/hoqAcVsSyTO/DBLsobUvI9nv9FEHZOyERf+UNXwByEL6f2uI6FakfXQwlwMjFcN3r3ao17CPxYCmHOC0+i+9TVqV+G0ofO8=
Received: from DM6PR06MB3977.namprd06.prod.outlook.com (20.176.67.31) by DM6PR06MB3979.namprd06.prod.outlook.com (20.176.67.33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.841.17; Sun, 10 Jun 2018 07:51:13 +0000
Received: from DM6PR06MB3977.namprd06.prod.outlook.com ([fe80::94e7:798c:7516:bf1f]) by DM6PR06MB3977.namprd06.prod.outlook.com ([fe80::94e7:798c:7516:bf1f%3]) with mapi id 15.20.0841.019; Sun, 10 Jun 2018 07:51:13 +0000
From: Dan York <york@isoc.org>
To: "Rfc-markdown@ietf.org" <Rfc-markdown@ietf.org>
Thread-Topic: Am I missing any tools for markdown -> RFC?
Thread-Index: AQHUAI/Ncl6xZXXup027hX6XbCMizA==
Date: Sun, 10 Jun 2018 07:51:13 +0000
Message-ID: <C398444D-18AD-443D-96DC-6E9B3A0B5125@isoc.org>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=york@isoc.org;
x-originating-ip: [74.75.84.32]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; DM6PR06MB3979; 7:UDYL6FSr0h7Zax3ktgcX0r4gTwVtVcjLdyRGbDXu5lz4A/ejAZNpHXSNjJuHSRG2iRaAE2qGSHgSLloOp467WgE2+qAz6Xct5MB0cduzgGU8jW5zRHVQM3an2l4CDDg+3Uu8/2+CDEHxF1nkgQ1BzrzqIv+Z3iEP08S+NVHsatzhE0aDKVtK2AvHTXeJw4k8B35JTmqkp/jwOhkK9e5tdVt0nks3kaU52geffx8h5shqYHuesJYtuCxIu4CpfCx3
x-ms-exchange-antispam-srfa-diagnostics: SOS;
x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(5600026)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020); SRVR:DM6PR06MB3979;
x-ms-traffictypediagnostic: DM6PR06MB3979:
x-microsoft-antispam-prvs: <DM6PR06MB3979F60329252D1DB7C1573AB7790@DM6PR06MB3979.namprd06.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(166708455590820)(31418570063057)(111885846020525);
x-ms-exchange-senderadcheck: 1
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(6040522)(2401047)(5005006)(8121501046)(3231254)(944501410)(52105095)(93006095)(93001095)(10201501046)(3002001)(149027)(150027)(6041310)(20161123562045)(20161123564045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(20161123560045)(6072148)(201708071742011)(7699016); SRVR:DM6PR06MB3979; BCL:0; PCL:0; RULEID:; SRVR:DM6PR06MB3979;
x-forefront-prvs: 0699FCD394
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(366004)(39830400003)(346002)(376002)(39380400002)(396003)(199004)(189003)(54896002)(6512007)(6916009)(236005)(5250100002)(6306002)(476003)(3660700001)(26005)(83716003)(486006)(2616005)(7736002)(99286004)(36756003)(53376002)(606006)(5640700003)(66066001)(2906002)(68736007)(5660300001)(2501003)(53936002)(2351001)(6436002)(6506007)(81166006)(81156014)(316002)(186003)(8936002)(6486002)(3280700002)(33656002)(3846002)(6116002)(102836004)(2900100001)(25786009)(105586002)(106356001)(8676002)(97736004)(478600001)(82746002)(14454004)(86362001)(966005)(554374003); DIR:OUT; SFP:1101; SCL:1; SRVR:DM6PR06MB3979; H:DM6PR06MB3977.namprd06.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1;
received-spf: None (protection.outlook.com: isoc.org does not designate permitted sender hosts)
x-microsoft-antispam-message-info: /GO/gnACdY3wj2uiTUuDxx73TivFaKHB/ymUScVa49MLuJ+l8dYAJouoF7cI4NBzq/DmLVbxJXX6qORgd5qrdMgeE/1Q2D4keR/3Fa7JBwqIgjZUFy/YUv1PMSYpCaTnTMtNES07ApyHXUqiFUKp0D0+dqzBSYPStMZp+r6pUX7KHO41yUwheDlHTkxzg3m/
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: multipart/alternative; boundary="_000_C398444D18AD443D96DC6E9B3A0B5125isocorg_"
MIME-Version: 1.0
X-MS-Office365-Filtering-Correlation-Id: 8060f744-3945-40c2-9660-08d5cea6f070
X-OriginatorOrg: isoc.org
X-MS-Exchange-CrossTenant-Network-Message-Id: 8060f744-3945-40c2-9660-08d5cea6f070
X-MS-Exchange-CrossTenant-originalarrivaltime: 10 Jun 2018 07:51:13.4409 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 89f84dfb-7285-4810-bc4d-8b9b5794554f
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR06MB3979
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/NRIyjDahc4sgnjE_ArgBF51am4s>
Subject: [Rfc-markdown] Am I missing any tools for markdown -> RFC?
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.26
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: <https://mailarchive.ietf.org/arch/browse/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: Sun, 10 Jun 2018 07:51:19 -0000

Hi,

I volunteered to give a brief presentation on Tuesday evening to a group of IETFers in Boston about using markdown to write RFCs. As part of that, I want to present the different tools people can use. Right now I am aware of:

- kramdown - https://github.com/cabo/kramdown-rfc2629

- mmark - https://github.com/miekg/mmark (and the companion Docker tool: https://github.com/paulej/rfctools )

- pandoc - https://www.rfc-editor.org/rfc/rfc7328.txt

- draftr -  https://ipv.sx/draftr/

I will also point out Martin’s excellent I-D template: https://github.com/martinthomson/i-d-template/<https://github.com/martinthomson/i-d-template/blob/master/README.md>

Are there any other tools you are aware of people using to convert markdown to RFCs?

On a related note, I am aware of this existing tutorial on kramdown:

https://www.ietf.org/about/participate/tutorials/process/writing-rfcs-and-internet-drafts-markdown-and-bit-yaml/

Are there other existing tutorials / presentations / slides out there to which I should point people?

Thanks,
Dan

P.S. This talk is part of a “IETF hub Boston” meeting that Alia Atlas has been organizing in our region. It won’t be recorded or streamed... but I may write an article / blog post about this when I am done.

--
Dan York
york@isoc.org<mailto:york@isoc.org>
+1-802-735-1624
skype:danyork
http://twitter.com/danyork

v2.23.0 | Report a Bug | By Email