Re: [Rfc-markdown] Markdown for presentations

Carsten Bormann <cabo@tzi.org> Thu, 22 July 2021 13:46 UTC

Return-Path: <cabo@tzi.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 61F5E3A4714 for <rfc-markdown@ietfa.amsl.com>; Thu, 22 Jul 2021 06:46:00 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=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 XFt7VHmJFsI1 for <rfc-markdown@ietfa.amsl.com>; Thu, 22 Jul 2021 06:45:55 -0700 (PDT)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [IPv6:2001:638:708:32::15]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 160133A4712 for <rfc-markdown@ietf.org>; Thu, 22 Jul 2021 06:45:54 -0700 (PDT)
Received: from [192.168.217.118] (p548dcc89.dip0.t-ipconnect.de [84.141.204.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by gabriel-smtp.zfn.uni-bremen.de (Postfix) with ESMTPSA id 4GVty90rj2z2xLD; Thu, 22 Jul 2021 15:45:53 +0200 (CEST)
Content-Type: text/plain; charset=utf-8
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.7\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <3aa516c7-20fa-c424-3664-10dbb8e54538@emailplus.org>
Date: Thu, 22 Jul 2021 15:45:52 +0200
Cc: rfc-markdown@ietf.org
X-Mao-Original-Outgoing-Id: 648654352.6005321-ccc3407551cfd574bed43b5f29511f46
Content-Transfer-Encoding: quoted-printable
Message-Id: <9BC67769-0E8B-49B7-A90D-F61ED1651BE4@tzi.org>
References: <3aa516c7-20fa-c424-3664-10dbb8e54538@emailplus.org>
To: Benson Muite <benson_muite@emailplus.org>
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-markdown/aRe6hGOyLfpBmbLRq05rLHtVdrA>
Subject: Re: [Rfc-markdown] Markdown for presentations
X-BeenThere: rfc-markdown@ietf.org
X-Mailman-Version: 2.1.29
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: Thu, 22 Jul 2021 13:46:00 -0000

On 2021-07-22, at 08:49, Benson Muite <benson_muite@emailplus.org> wrote:
> 
> One of the hackathon templates uses Markdown:
> https://github.com/IETF-Hackathon/ietf111-project-presentations
> As the format is very user friendly, it may be something that is useful to consider when creating and modifying markdown related RFCs

Nice.  I started doing something like this in the mid-1980s (before markdown was invented :-), based on troff and a lex-based [101 lines of code] textile-like markup language, inspired by the outliners of the day), and I have been convinced since that this is the right way to create slides for my lectures.

There also have been various HTML-based slide presenters.  In the mid-2000s s5.html was popular; today reveal.js seems to be leading the mindshare in javascript packages for putting up HTML-based slides.

remark [1] [2], as used by the hackathon template, enables the use of markdown inside such an HTML-based deck; the JavaScript slide presenter inside an HTML shell essentially interprets that pasted-in markdown.

Today, many markdown-based tools also include a slide mode.
For instance the markdown-based collaborative editor Hedgedoc (née hackmd and then for a while CodiMD) has a slide mode; this is directly accessible on IETF’s codimd.ietf.org as well.

I personally use a paid Mac-only tool called Deckset (which I cannot recommend to IETFers, but only because of “the illusion of vendor support” [RFC0873]).  It does serve me well, and the markdown ports back and forth great between code, slides, and I-Ds.

The slide deck aspect (new slide, incremental builds, footers, styles) of markdown isn’t really written down, so everyone has their own little markdown extensions, e.g., [3], but these are similar enough and slide decks are usually small enough that a little hand conversion doesn’t hurt too much.

Grüße, Carsten

[1]: https://github.com/gnab/remark
[2]: https://remarkjs.com/
[RFC0873]: Padlipsky, M., "Illusion of vendor support", RFC 873, DOI 10.17487/RFC0873, September 1982, <https://www.rfc-editor.org/info/rfc873>.
[3]: https://github.com/gnab/remark/wiki/Markdown