Orchid has had a great month, y'all!
As Orchid is getting more popular, there is a growing need to keep the community up-to-date on all the happenings around Orchid. This post is the first in a new monthly series where I will share Orchid's progress during the previous month! Follow along with this series to stay on top of Orchid's newest features, track adoption on Github, and see who's using Orchid!
As this is the first post in this series, I will just get everyone caught up with Orchid's major milestones since October, because Hacktoberfest was really great for Orchid too.
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…
On Github
Orchid just hit 100 stars at the end of October, and it's up to 108 as of the time of writing. Thanks for all the support, I'm amazed that this little side-project of mine has been so popular! Keep the sharing going!
The Orchid repo also received contributions from the following people, thanks so much for the help!
New Features
Orchid 0.13.0 and 0.14.0 were released around Thanksgiving, and together mark the biggest Orchid release to-date! This includes:
- Update to Kotlin 1.3
- Wikis can now generate PDFs for offline documentation. See documentation here.
- A new Asset Manager improves build times, and intelligently renders your image assets. It even includes basic image manipulation for automated thumbnail generation! Learn more about media management here.
Who's Using Orchid?
Orchid now powers the documentation for two really incredible open-source projects, go check them out!
- Pebble is the main template engine used by Orchid, and pebbletemplates.io was officially launched on November 11. Some of the most notable Orchid features it uses are:
- Editorial theme
- Changelogs and automated Github releases
- Wiki with offline documentation
- Javadocs Java source code documentation
- Deployment to Github Pages
- Strikt is a new assertion library for Kotlin, and strikt.io went live October 19th using the following Orchid features:
- A fully-custom theme, including custom template tags
- Changelogs
- Wiki
- Kotlindocs Kotlin source code documentation
- Deployment to Github Pages
In addition, my personal website at caseyjbrooks.com got a major facelift. It previously used the FutureImperfect theme, but I have been working on creating a custom theme based on Bulma, with some very helpful advice from @aspittel's Profile Advice Thread. When the theme is finished, it will be merged into the main Orchid repo, so you can use it for your Orchid sites too!
Are you interested in getting started with Orchid? There simply is no better way to manage all the documentation for your project, and I'd love to help you get set up!
If you have an open-source project that needs docs, are building a new portfolio, or are building any other kind of static site, I want to work with you to get you set up with Orchid! Comment on this post, send me a PM here on Dev.to, or contact me here and I will be with you every step of the way.
And as always, let me know if you start using Orchid so I can feature you in next month's update!
Top comments (0)