!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem92 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
25 Aug 2023
@lucperkins:matrix.orgLuc Perkins * How extensible is mmdoc? I remember playing around with it and I like it that it's lightweight, but how trivial/non-trivial would it be to provide things like admonitions, headings that are linkable on hover, TOCs, footnotes, and other not-quite-standard-Markdown-but-nonetheless-widely-used things?21:24:54
@lucperkins:matrix.orgLuc PerkinsAs far as I can tell, cmark is fairly rigid21:26:04
@lucperkins:matrix.orgLuc Perkins(but I barely know C so my comb through the cmark codebase shouldn't be taken as final 😄)21:26:45
@ryantm:matrix.orgryantmIt already supports admonitions (:::), though not all the formats used by Nixpkgs right now, like it doesn't support anchors inside admonitions.22:41:21
@ryantm:matrix.orgryantmHeaders are already linkable. TOCs is the primary way it works, you have to specify the TOC of each page included. No footnote support currently. https://ryantm.github.io/mmdoc/usage/#usage22:42:43
@ryantm:matrix.orgryantmThe parsers for these various addons are at https://github.com/ryantm/mmdoc/blob/main/src/parse.c22:43:48
@ryantm:matrix.orgryantmcmark has this way of hooking into its renderer to provide your own stuff: https://github.com/ryantm/mmdoc/blob/5f5a2734595cf42167cef2bb3c0e61cdc0185119/src/render.c#L45322:47:42
26 Aug 2023
@lucperkins:matrix.orgLuc PerkinsOkie doke! Not arguing for or against, just curious00:32:46

Show newer messages


Back to Room ListRoom Version: 6