A beautiful and truly unique documentation engine and static site generator.
Currently 0.9.3
A beautiful and truly unique documentation engine and static site generator.
Currently 0.9.3
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.
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.
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.
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.
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.
1 plugins {
2 id "com.eden.orchidPlugin" version "0.9.3"
3 id "com.eden.orchidJavadocPlugin" version "0.9.3" // if using Orchid for Javadocs
4 }
5 repositories {
6 jcenter()
7 maven { url 'https://dl.bintray.com/javaeden/Orchid/' }
8 maven { url 'https://jitpack.io' }
9 }
10 dependencies {
11 orchidCompile 'io.github.javaeden.orchid:OrchidAll:0.9.3'
12 }
13 orchid {
14 theme = "BsDoc"
15 baseUrl = "http://localhost:8080"
16 }
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.
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.