!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

409 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
13 Jul 2021
@jtojnar:matrix.orgJan Tojnarif we carry over as much as possible, we can then decide we do not want to have manpage links00:43:02
@jtojnar:matrix.orgJan Tojnarbut if we drop them in conversion, it will be PITA to add them back00:43:23
@jtojnar:matrix.orgJan Tojnareventually, I want to make a RFC evaluating each feature individually, based on different criteria00:46:55
@jtojnar:matrix.orgJan Tojnarbut until then, I want to preserve everything that is reasonably simple to preserve00:47:38
@ryantm:matrix.orgryantmSounds good.00:55:03
@jtojnar:matrix.orgJan Tojnar ryantm: I want to recommend the db-to-md script from the PR instead of manual pandoc+prettier invocation 00:58:31
@jtojnar:matrix.orgJan Tojnarnow that we convinced pandoc to use fenced code blocks, we should not even need prettier00:59:34
@ryantm:matrix.orgryantmMaybe we could avoid "footnote" link magic, but aggregating the "footnote" links across the whole set of documents.01:00:16
@ryantm:matrix.orgryantm By "footnote" link, I mean the [link][1] ones 01:00:36
@jtojnar:matrix.orgJan Tojnar so not actual footnotes [link][^1]? 01:01:41
@ryantm:matrix.orgryantmOh, that's a thing in some extension?01:02:33
@jtojnar:matrix.orgJan Tojnar
In reply to @ryantm:matrix.org
Maybe we could avoid "footnote" link magic, but aggregating the "footnote" links across the whole set of documents.
that would be pretty simple by concating the link target definitions to each md file
01:03:06
@jtojnar:matrix.orgJan Tojnarextras would just be ignored01:03:16
@jtojnar:matrix.orgJan Tojnar
In reply to @ryantm:matrix.org
Oh, that's a thing in some extension?
yeah, pandoc supports it
01:03:25
@ryantm:matrix.orgryantm

I just meant the one like this:

[Link][1]
⋮
[1]: http://b.org
01:03:37
@jtojnar:matrix.orgJan Tojnaryou can even use strings instead of numbers01:03:49
@ryantm:matrix.orgryantmRight.01:03:57
@ryantm:matrix.orgryantmSo there could be ones for all the NixOS options, and all the common manpages.01:04:24
@ryantm:matrix.orgryantmThough I guess NixOS options might be xrefs?01:04:48
@jtojnar:matrix.orgJan Tojnaryeah, xref work for options for now 01:05:35
@jtojnar:matrix.orgJan Tojnar I think I still like {manpage}`foo(5)` more compared to something like [][foo(5)], which would still need us to fill in the link text 01:07:53
@jtojnar:matrix.orgJan Tojnarso we would need some way to annotate the anchors that they are manpages01:08:34
@jtojnar:matrix.orgJan Tojnar Or write [`foo(5)`][foo(5)] which is IMO even worse for writers than the MyST role. 01:10:05
@jtojnar:matrix.orgJan Tojnar Something like [](man:foo(5) would bring best of both worlds, I feel, but it is non-standard. 01:12:34
@jtojnar:matrix.orgJan Tojnar * Something like [](man:foo(5)) would bring best of both worlds, I feel, but it is non-standard. 01:12:41
@jtojnar:matrix.orgJan Tojnar * Something like [](man:foo(5)) would bring best of both worlds – easily processable yet simple to type, but it is non-standard. 01:13:53
@jtojnar:matrix.orgJan Tojnar * Something like [](man:foo(5)) would bring best of both worlds – easily processable yet simple to type. But it is non-standard. 01:14:44
@jtojnar:matrix.orgJan TojnarFor others reading this, the PR: https://github.com/NixOS/nixpkgs/pull/13004702:06:18
@blaggacao:matrix.orgDavid Arnold (blaggacao)
In reply to @jtojnar:matrix.org
Or write [`foo(5)`][foo(5)] which is IMO even worse for writers than the MyST role.

Have we considered

[`foo(5)`][]

[`foo(5)`]: http://b.org

?

11:08:40
@blaggacao:matrix.orgDavid Arnold (blaggacao)That's how I would intuitively write it, probably even with a MyST role in place.11:13:55

Show newer messages


Back to Room ListRoom Version: 6