OrchidSourceDoc

The base module for adding code documentation to Orchid with Kodiak


About

This is the base plugin for documenting source code with Orchid for all supported languages. Orchid supports modular projects, with READMEs and separate doc groups for each module, customizable permalinks, multiple types of menu items, and supports full-text search from the OrchidSearch plugin.

No matter which language you are using, its usage is all identical as it is provided by this base plugin.

The suite of Orchid Sourcedocs plugins are for designed for merging source code documentation with the rest of your project site.

Orchid Sourcedocs supports multi-module projects with READMEs and separate doc groups for each module, customizable permalinks, auto-updating menu items, and an ever-improving data model to link to doc pages and display the relationships among different elements.

It also integrates client-side full-text search from the OrchidSearch plugin and is set up for easy page querying or archive generation with the OrchidTaxonomies plugin.

The following languages are currently supported:

Installation

dependencies {
    orchidRuntime("io.github.javaeden.orchid:OrchidSourceDoc:0.21.0")
}
<dependency>
    <groupId>io.github.javaeden.orchid</groupId>
    <artifactId>OrchidSourceDoc</artifactId>
    <version>0.21.0</version>
    <type>pom</type>
</dependency>
libraryDependencies += "io.github.javaeden.orchid" % "OrchidSourceDoc" % "0.21.0"
@file:DependsOn("io.github.javaeden.orchid:OrchidSourceDoc:0.21.0")