Orchid

(Linux and Mac) (Windows)

A beautiful and truly unique documentation engine and static site generator.

Example Orchid site

Orchid is a general-purpose static site generator with a focus on extensibility, and aimed at developers looking to improve their technical documentation. Orchid was born out of a desire for better-looking Javadocs and frustration with how difficult is it to manage large Jekyll sites and keep it up-to-date with your code.

Orchid supports a variety of plugins, including a wiki, static pages, blogs, and much more. It aims to have high compatibility with many of the existing static site generators, such as Jekyll, Gitbook, and Hugo, so that migration to Orchid is painless. And if you can't find a plugin to do what you need, Orchid provides an intuitive way to add your own private plugins and a rich API so you can make your site as beautiful and unique as an Orchid.

Features

Plugin-driven Architecture
Multi-theme support
Admin interface to manage your content and gain deep insights into your build
Link to other Orchid sites
Powerful and flexible indexing, unique to Orchid
Fully replaces Jekyll, Gitbook, Javadocs, and more!

View the full documentation or see the quick-start below.

Installation
Configuration
Development Progress
License
Contributing
Contact

Installation

Orchid integrates with any new or existing Gradle project. To get started, pick a Bundle (OrchidAll, OrchidBlog, or OrchidProduct) or manually choose your desired Orchid plugins. You may pick a bundle to start with and add any number of plugins afterward, both official and unofficial. Then, setup your project's build.gradle file like so:


plugins {
    // Add the official Orchid Gradle plugin so you can use Orchid with the custom DSL   
    id "com.eden.orchidPlugin" version "{version}"
}

repositories {
    // Orchid uses dependencies from both Jcenter and Jitpack, so both must be included. jcenter also includes 
    // everything available from MavenCentral, while Jitpack makes accessible any Github project.
    jcenter() 
    maven { url 'https://jitpack.io' }
}

dependencies {
    // Add an Orchid Bundle. OrchidAll comes with all official themes included.
    // You must include a theme separately when using the OrchidBlog and OrchidProduct bundles 
    orchidDocsRuntime 'io.github.javaeden.orchid:OrchidAll:{version}'
}

orchid {
    // Version, theme, and baseUrl are required
    version = "${project.version}"
    theme   = "{theme}"
    
    // The following properties are optional
    
    baseUrl = "{baseUrl}"                         // a baseUrl appended to all generated links. Defaults to '/'
    srcDir  = "path/to/new/source/directory"      // defaults to 'src/orchidDocs/resources'
    destDir = "path/to/new/destination/directory" // defaults to 'build/docs/javadoc'
    runTask = "build"                             // specify a task to run with 'gradle orchidRun'
}

You can now run Orchid in the following ways:

./gradlew orchidRun - Runs an Orchid task. The runTask should be specified in build.gradle or passed as a Gradle project property (-PrunTask=build). The task listTasks will show a list of all tasks that can be run given the plugins currently installed. Similarly, listOptions will list all options that can be set through Gradle.
./gradlew orchidBuild - Runs the Orchid build task a single time then exits. The resulting Orchid site will be in build/docs/javadoc unless the output directory has been changed.
./gradlew orchidServe - Sets up a development server and watches files for changes. Must have the OrchidServer plugin installed for this task to work, which is included in all the above bundles.
If you are developing a Java application, Orchid replaces the standard Javadoc task with its own build task. In addition to running the standard Orchid build, when Orchid is run from Javadoc it will be able to create pages for all your project's classes and packages, just like you'd expect from a normal Javadoc site, but embedded within your chosen Orchid theme. You must have the OrchidJavadoc plugin installed for this to work properly.

On windows, all the above commands need to be run with gradlew instead of ./gradlew.

The Orchid Gradle plugin adds a new configuration and content root to your project, in the src/orchidDocs directory (you may have to create this folder yourself). All your site content sits in src/orchidDocs/resources, and any additional classes you'd like to include as a private plugin can be placed in src/orchidDocs/java.

Configuration

You should create a config.yml file in your resources directory to customize your theme or configure your build. These values can then be used in all templates and when preprocessing your content files under the options variable. Alternatively, you may create a file in data/ with your data which will be accessible at options.[filename].

Development Progress

Orchid is still in the early stages of development. While much of the public API is solid and not likely to change, I make no guarantees that any particular API will not change or be removed. In addition, themes are likely to change significantly, so any custom templates may not behave as expected after an Orchid update.

The following table lists all Orchid packages currently in development:

Core Packages

Name	Version
Orchid Core
Orchid Gradle Plugin

Themes

Name	Version
OrchidBsDoc
OrchidEditorial
OrchidFutureImperfect
OrchidMaterialize

Plugins

Name	Version
Changelog
Javadoc
KSS Styleguide
LanguagePack
Pages
Posts
Wiki

License

Orchid is open-source software licensed under the GNU Lesser General Public License (LGPL). See License.md for more information.

Contributing

This repository is comprised of many individual projects, which are all listed above. You can build and run any project with Gradle from the project root, such as gradle :OrchidCore:assemble or gradle :plugins:OrchidWiki:assemble, or you may navigate to a particular project's subdirectory to run the Gradle commands directly. When contributing code, please indent using 4 spaces and keep braces on the same lines.

To release a new version of Orchid:

Orchid Core, and all plugins and themes:
- Start with clean Git index
- Increment version in root build.gradle, according to Semantic Versioning and prefixed with v
- Commit and push version change
- gradle clean build deploy -Penv=prod (requires API keys and credentials for Github and Bintray)
Orchid Gradle Plugin
- Start with clean Git index
- cd buildSrc (buildSrc is not recognized as a normal part of the Gradle project, but its is a project in its own local directory)
- Increment version in buildSrc/build.gradle, according to Semantic Versioning and prefixed with v
- gradle publishPlugins

Contact

Orchid is being actively developed by Casey Brooks. Please open an issue here with questions or bug/feature requests, or you can reach me directly at [email protected].

               GNU LESSER GENERAL PUBLIC LICENSE
                   Version 3, 29 June 2007

This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.

Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License.

"The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version".

The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.

Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.

Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:

a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.

Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license document.

Combined Works.

You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:

a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license document.

c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.

d) Do one of the following:

   0) Convey the Minimal Corresponding Source under the terms of this
   License, and the Corresponding Application Code in a form
   suitable for, and under terms that permit, the user to
   recombine or relink the Application with a modified version of
   the Linked Version to produce a modified Combined Work, in the
   manner specified by section 6 of the GNU GPL for conveying
   Corresponding Source.

   1) Use a suitable shared library mechanism for linking with the
   Library.  A suitable mechanism is one that (a) uses at run time
   a copy of the Library already present on the user's computer
   system, and (b) will operate properly with a modified version
   of the Library that is interface-compatible with the Linked
   Version.

e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)

Combined Libraries.

You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.

Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.