Description
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.
Orchid alternatives and similar software solutions
Based on the "Static Site Generators" category.
Alternatively, view Orchid alternatives based on common mentions on social networks and blogs.
-
Jekyll
:globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby -
mdBook
Create book from markdown files. Like Gitbook but implemented in Rust -
Pelican
Static site generator that supports Markdown and reST syntax. Powered by Python. -
Octopress
Octopress is an obsessively designed framework for Jekyll blogging. It’s easy to configure and easy to deploy. Sweet huh? -
Metalsmith
An extremely simple, pluggable static site generator for Node.js -
JBake
Java based open source static site/blog generator for developers & designers. -
Cleaver
🔥🔪 A blazing-fast static site generator using Laravel's Blade templating engine
InfluxDB - Power Real-Time Data Analytics at Scale
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Orchid or a related project?
Popular Comparisons
README
Build and deploy beautiful documentation sites that grow with you Quick-Start • Documentation • Tutorials • Showcase • Support
Quick-Start
Orchid 0.X.X versions are published to JCenter at artifact coordinates like io.github.javaeden.orchid:OrchidCore:0.21.1
or io.github.javaeden.orchid:OrchidWiki:0.21.1
. JCenter is deprecated, and once Orchid 1.0.0 is published, so will all 0.X.X versions.
Starting with version 1.0.0, Orchid will be published to MavenCentral under new artifact coordinates, like io.github.copper-leaf.orchid:orchid-core:1.0.0
or io.github.copper-leaf.orchid:orchid-wiki-feature:1.0.0
.
In-development snapshot versions will be available in Sonatype's new (s01) snapshots repository. Snapshots are published after every successful build on the dev
branch.
Documentation
Orchid's User Manual will walk you through the main features of Orchid and give you a deeper understanding of each topic and feature.
Tutorials
There are several tutorials designed to walk you through building an Orchid site from scratch. The source for all tutorials can also be found in the OrchidTutorials repository.
Showcase
View the Showcase to see Orchid in action.
Support
Contributors
This project exists thanks to all the people who contribute. To get involved, please see CONTRIBUTING.md
Backers
Thank you to all our backers! 🙏
Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
License
Orchid is open-source software licensed under the GNU General Public License (GPL-3.0). Please see License.md
Contact
Orchid is being actively developed by Casey Brooks. You can reach out with questions, bug reports, or feature requests on any of the following:
*Note that all licence references and agreements mentioned in the Orchid README section above
are relevant to that project's source code only.