nixdoc icon indicating copy to clipboard operation
nixdoc copied to clipboard

Feature request: Support generating multiple formats

Open ghost opened this issue 3 years ago • 1 comments

Instead of focusing on DocBook vs CommonMark, I think it would be good to instead introduce a --format param or something similar that allows outputing to a chosen format. This would allow nixdoc to be more versatile and flexible for future formats.

IMO, it would be good to generate something that other, fantastic, documentation generators might be able to use. doxygen, rustdoc, javadoc, sphinx etc. all generate documentation that is searchable, has links back to the source, have syntax highlighting, etc. Being able to output a format that they (or another tool) might understand would probably significantly decrease the effort needed to recreate output similar to theirs.

ghost avatar Jan 14 '23 12:01 ghost

Related: #129

infinisil avatar Aug 07 '24 04:08 infinisil