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

Render Kroxylicious Javadoc (or redirect to Javadoc.io) on the website with Jekyll #45

Open
gracegrimwood opened this issue Mar 20, 2024 · 1 comment

Comments

@gracegrimwood
Copy link
Contributor

Relates to #44 and kroxylicious/kroxylicious#238

I think it would simplify things if we rendered the Javadoc ourselves on the website (because we could then apply site styles and link back to the website from the Javadoc pages for easier navigation) but at the very least we should link to the Javadoc from the site. Jekyll doesn't have a plugin for Javadoc, but as Maven is capable of spitting out static site files from Javadoc and Jekyll is capable of handling static files, we can just tell Jekyll to serve them as-is.

Related to #44 because if we were to render it on the website I imagine it would be a very similar process to what we'd need to do with the AsciiDoc, although without the need for any new Jekyll plugins.

@k-wall
Copy link
Contributor

k-wall commented Apr 24, 2024

I think linking to Javadoc.io is good enough.

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

2 participants