Re: [Tools-discuss] [irsg] [EXTERNAL] Question about Codimd for w.g. minutes

Carsten Bormann <cabo@tzi.org> Fri, 30 July 2021 11:13 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id C08873A268B; Fri, 30 Jul 2021 04:13:58 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.296
X-Spam-Level:
X-Spam-Status: No, score=-1.296 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, URIBL_SBL=0.5, URIBL_SBL_A=0.1] autolearn=no 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 7FitpJAhnAZk; Fri, 30 Jul 2021 04:13:53 -0700 (PDT)
Received: from gabriel-smtp.zfn.uni-bremen.de (gabriel-smtp.zfn.uni-bremen.de [134.102.50.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 8AD633A2683; Fri, 30 Jul 2021 04:13:53 -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 4GblC26rxbz31Xm; Fri, 30 Jul 2021 13:13:50 +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: <BFF67007-67E4-46E3-9A46-2A5E79ED3349@gmail.com>
Date: Fri, 30 Jul 2021 13:13:50 +0200
Cc: Robert Sparks <rjsparks@nostrum.com>, Tools Team Discussion <tools-discuss@ietf.org>, rfc-markdown@ietf.org
X-Mao-Original-Outgoing-Id: 649336430.505282-e5673245bdf204ac1ef334a82ca765a3
Content-Transfer-Encoding: quoted-printable
Message-Id: <21540E71-F991-4F26-BC4D-79595A6F6DBB@tzi.org>
References: <43AD0E13-4450-4CB1-AC3E-4A73408B613F@tzi.org> <F09E955A-61E8-411A-B1DE-7C9036E352A6@nostrum.com> <BFF67007-67E4-46E3-9A46-2A5E79ED3349@gmail.com>
To: Bob Hinden <bob.hinden@gmail.com>
X-Mailer: Apple Mail (2.3608.120.23.2.7)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/P-o6opr6z0CN5KchptsWkwcUHak>
Subject: Re: [Tools-discuss] [irsg] [EXTERNAL] Question about Codimd for w.g. minutes
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 30 Jul 2021 11:13:59 -0000

On 2021-07-30, at 02:39, Bob Hinden <bob.hinden@gmail.com> wrote:
> 
> I hope we can make sure that the common tools like Codimd and the Datatracker do compatible things.   

I have been informed by a friendly HedgeDoc maintainer (HedgeDoc = independent open-source version of CodiMD) that this is easy to achieve [0].  Just insert

---
breaks: false
...

at the start of the CodiMD document and all will be standard(*).

(This also can be set system-wide, but that might break existing documents written without this.)

I’d stick with the CodiMD default `breaks: true`, though, as this is nicer for note-taking; see [1] for the discussion that led to this being the default for hedgedoc.  This is where the de-gfm tool that is now in kramdown-rfc will come in handy.  Or let CodiMD do the HTML conversion, but then there is no standard markdown to put into repos etc.

Grüße, Carsten


[0]: https://demo.hedgedoc.org/s/yaml-metadata#breaks

(*) note that the docs say

---
breaks: false
---

(probably because it’s more pleasingly symmetrical) but that is not standard YAML, so I recommend the three-dot version (which is also the one accepted in kramdown-rfc documents.).

[1]: https://community.hedgedoc.org/t/should-we-change-the-hedgedoc-default-for-breaks-from-true-to-false/298
Beautiful “vote” in there!