Fork me on GitHub

Orchid Logo

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

Get Started

Currently 0.13.0



Orchid is a brand-new, general-purpose static site generator for Java and Kotlin, 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
  • Full-text static search
  • Component-based content management
  • Integrated deployment pipeline
  • Fully replaces Jekyll, Hugo, Gitbook, Javadocs, and more!
lock_outline

Fast and Secure

JAM is the new stack. No more messing around with slow databases or insecure servers. Content goes in, HTML comes out, there's nothing more to worry about.

chrome_reader_mode

Simple yet Robust

Just write your content, no coding required. Orchid's robust set of tools are approachable for content writers and editors, but won't limit the creativity of developers and designers.

code

Powerful and Flexible

Orchid's unique indexing and plugin system allows the most complex ideas to be expressed in a way that works well with the entire ecosystem. Chose from one of the many plugins in our catalog or make your own.

local_florist

Beautiful and Truly Unique

Whether you're writing a blog, marketing your business, or documenting your code, Orchid can handle it all beautifully. It's your site, make it unique, just like you.


Hassle-Free Setup

With one click, you can get Orchid deployed to Netlify, complete with the Netlify CMS already configured. Plus, the NetlifyCMS automatically adapts to your Orchid plugins and configurations, all you have to do is write.




Alternatively, download the starter project and run Orchid locally. No complicated build environment to set up, just use the included Gradle wrapper. When you're ready to go live, simply push your site to Github.
git clone https://github.com/JavaEden/OrchidStarter.git
cd OrchidStarter
./gradlew orchidServe

# View your generated site at http://localhost:8080/

Or embed Orchid directly in your existing Gradle projects, replacing the outdated styling of Javadocs with the elegance of Orchid.
 1 plugins {
 2     id "com.eden.orchidPlugin" version "0.13.0"
 3 }
 4 repositories {
 5     jcenter()
 6     maven { url "https://kotlin.bintray.com/kotlinx" }
 7     maven { url 'https://dl.bintray.com/javaeden/Orchid/' }
 8     maven { url 'https://dl.bintray.com/javaeden/Eden/' }
 9     maven { url 'https://jitpack.io' }
10 }
11 dependencies {
12     orchidCompile 'io.github.javaeden.orchid:OrchidAll:0.13.0'
13 }
14 orchid {
15     theme   = "BsDoc"
16     baseUrl = "http://localhost:8080"
17 }

trending_up

Built for Scale

Orchid is capable of generating sites with hundreds or thousands of pages in seconds without even breaking a sweat. In addition, Orchid has many novel ways to configure large groups of pages from one central location, so you are never locked into a single theme or configuration, no matter how large your site is. With performance that rivals the best tools on the market and flexibility that simply cannot be matched by anything else out there, Orchid will not only replace your current static site generator, but do it better and faster, while being an absolute joy to work with.

cloud_done

Designed for the Modern Web

Orchid ships with Markdown, SCSS, and Pebble compilers built-in, which make designing your site and managing your content a breeze, with additional languages like Asciidoctor available as plugins. Orchid also has features like full-text static search, a modular architecture with component-based design system, integration with the Netlify CMS, and sites are easily deployed to Netlify, Amazon S3, Github Pages, or any other static web host.


Open-source, with ❤

Orchid is complete free and open-source, and always will be. Pick from one of our many great themes or plugins, or create your own. Plugins are really easy to make, even if you want to keep them private, and they are what unlock the full potential of Orchid. Check out the source code to see just how simple it is to make something truly unique.

What are you waiting for? Build your free website today.