Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Support generating multiple formats #28

Open
ghost opened this issue Jan 14, 2023 · 1 comment
Open

Feature request: Support generating multiple formats #28

ghost opened this issue Jan 14, 2023 · 1 comment

Comments

@ghost
Copy link

ghost commented Jan 14, 2023

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.

@infinisil
Copy link
Collaborator

Related: #129

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant