Orchid Javadoc

official

Orchid Javadoc


Where Orchid began. Create beautiful Javadocs for your project within your Orchid site.

Using Orchid with Javadoc

The Orchid Javadoc plugin integrates with the Javadoc tool to embed class and package info directly in your Orchid site. Orchid will even compile your Javadoc comments as Markdown!

Configuring Javadoc pages

Since pages for Javadoc classes and packages don't have a file on disk to write content or add Front Matter to, Orchid considers the Javadoc comment defined on the class or in the package-info.java files to be the pages "intrinsic content". The text of the comment is compiled as Markdown and rendered in the page, and the block-level Javadoc comment tags are used as the "Front Matter" configuration. While this is not as powerful as traditional Front Matter (because comment tags cannot be assigned as nested maps), it does offer a good solution for simple configuration. Alternatively, you may use Archetypes to configure all Class pages or all Package pages at once.

Include with:
dependencies {
    orchidRuntime 'io.github.javaeden.orchid:OrchidJavadoc:0.12.1'
}