nixdoc icon indicating copy to clipboard operation
nixdoc copied to clipboard

Discuss DocBook to CommonMark transition

Open ryantm opened this issue 4 years ago • 3 comments

Hi!

It recently came to my attention that this project is used in the nixpkgs manual. We've recently accepted a community proposal to change the manual from DocBook to CommonMark and are working on transitioning.. We are changing one section from DocBook to CommonMark at a time. Until we're done, we are using Pandoc to convert them back to DocBook for inclusion into the manual.

I am opening this issue to discuss if it makes sense to convert this library to output CommonMark instead of Docbook. Or, maybe it makes sense to use some other tool. Any advice would be appreciated.

- Ryan

ryantm avatar Dec 08 '20 05:12 ryantm

Nixpkgs' choice for markdown makes the choice for markup in comments (#5) a no-brainer.

roberth avatar May 29 '21 13:05 roberth

if it makes sense to convert this library to output CommonMark instead of Docbook

That's probably reasonable! Depending on the structure you're opting for it's likely much easier than the current docbook generation step.

I've moved this repository over to the nix-community organisation, and it's maintained by the docs team there - feel free to join if you're interested, especially because I don't know how much time I have for this at the moment (likely not much).

tazjin avatar May 29 '21 18:05 tazjin

@mightyiam I think this should be a straightforward first step to continue with the markdown migration.

fricklerhandwerk avatar Oct 12 '22 08:10 fricklerhandwerk

This has been closed by #25.

asymmetric avatar Mar 23 '23 11:03 asymmetric

Thank you.

mightyiam avatar Mar 23 '23 12:03 mightyiam