nixdoc icon indicating copy to clipboard operation
nixdoc copied to clipboard

Published 20 hours ago • verified publisher icon nix-community

feat: DocBook -> CommonMark

Open ryantm opened this issue 3 years ago • 1 comments

Output is CommonMark with some syntax extensions:

  • DD lists
  • heading anchors

ryantm avatar Jun 12 '21 04:06 ryantm

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/happy-docsgiving/10214/28

nixos-discourse avatar Jun 26 '21 17:06 nixos-discourse

@ryantm this PR looks ready isn't it?

zimbatm avatar Jan 06 '23 17:01 zimbatm

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/2023-03-14-documentation-team-meeting-notes-32/26351/1

nixos-discourse avatar Mar 15 '23 09:03 nixos-discourse

we would like to propose that this PR be updated to support examples as in https://github.com/NixOS/nixpkgs/pull/220116, which is very close to how pandoc represented examples (but can actually reconstruct a docbook title tag). that's the update discussed in the docs team meeting notes.

pennae avatar Mar 18 '23 21:03 pennae

@infinisil you're looking into updating this right?

asymmetric avatar Mar 19 '23 20:03 asymmetric

@ryantm this PR looks ready isn't it?

I've been testing the output of it in my version of the Nixpkgs manual for over a year now. https://ryantm.github.io/nixpkgs/functions/library/asserts/#sec-functions-library-asserts

So, yes, probably.

ryantm avatar Mar 20 '23 14:03 ryantm

I propose we merge this and address any further needs in follow-up PRs, since a) @ryantm has tested it for a long time and it works; and b) he's looking for new maintainers, so this could be a nice handover line.

asymmetric avatar Mar 20 '23 17:03 asymmetric