Skip to content

Latest commit

 

History

History
154 lines (122 loc) · 7.05 KB

README.md

File metadata and controls

154 lines (122 loc) · 7.05 KB

Orchid
Build and deploy beautiful documentation sites that grow with you


Maven Central (Releases) Sonatype Nexus (Snapshots) Build Status License: GPL-3.0 JDK: 8-16

Quick-Start Documentation Tutorials Showcase Support

Quick-Start

Gradle
Maven
SBT
Deploy to Netlify

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.

Documentation

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.

Tutorials

Showcase

View the Showcase to see Orchid in action.

Showcase

Support

Contributors

This project exists thanks to all the people who contribute. To get involved, please see CONTRIBUTING.md

Contributors

Backers

Thank you to all our backers! 🙏

Backers

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

Sponsor 1 Sponsor 2 Sponsor 3 Sponsor 4 Sponsor 5 Sponsor 6 Sponsor 7 Sponsor 8 Sponsor 9 Sponsor 10

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: