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

Output HTML docs #659

Open
bbkane opened this issue Feb 28, 2025 · 2 comments
Open

Output HTML docs #659

bbkane opened this issue Feb 28, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@bbkane
Copy link

bbkane commented Feb 28, 2025

Hello! Would it be possible to add HTML output so I can browse the generated docs directly on my browser instead of needing to convert them to HTML on the fly with my editor?

@bbkane bbkane added the enhancement New feature or request label Feb 28, 2025
@bbkane
Copy link
Author

bbkane commented Feb 28, 2025

https://pkg.go.dev/rsc.io/markdown might be a good option for this. It has few dependencies and is used for pkg.go.dev , so it'll probably stay maintained

@bbkane
Copy link
Author

bbkane commented Mar 1, 2025

Ooh, another alternative would be add a serve command and serve the docs live- it would be easy enough to just copy/paste from https://pkg.go.dev/rsc.io/cmd/mdweb

I'd be happy to add this as a PR if you're willing and I get the free time. Unfortunately I can't guarantee WHEN I'll have free time (job + family commitments, but I'll add it to the TODO list if you're ok with this feature request

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

No branches or pull requests

1 participant