loading...

re: 5 Free Static Documentation Generators You Must Check Out. VIEW POST

FULL DISCUSSION
 

I maintain Orchid and also use it for all my projects. It's a bit different than these documentation generators, in that it focuses on the entire documentation system rather than just Markdown content.

Orchid does all the normal stuff like Markdown wikis, blogs, changelogs, etc., but then brings in code documentation like Javadoc (currently supporting docs for 4 different languages), syntax highlighting, embeddable code playgrounds, and diagrams, all in the same site. And then it publishes the site to Github Pages too, to really make it encapsulate the entire process of maintaining a documentation website!

GitHub logo orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you

Orchid

Linux and Mac Build Status Windows Build status Current Version License: LGPL-3.0 Codacy Grade Codacy Coverage Gitter chat Backers on Open Collective Sponsors on Open Collective Open Source Helpers

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

Example Orchid site

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.

 

I'm a newbie when it comes to documentation. I didn't have to take care of it until recently. I'm currently maintaining a website that's composed from 3 projects : API, front end and an admin panel. Each with its own technologies and so on.
I'd like to build a documentation project for the entire application and publish it on my internal, private website (I'm using GitLab). Auto deploy is a bonus.

My question is: can I use Orchid for my needs and can I find a a guide that can help even a beginner like me set up and deploy the project on my private server?

 

The languages it currently supports are Java, Kotlin, Groovy, and Swift, but you can absolutely use Orchid without any of those and just use Orchid for your Markdown content and its other features. And it does support auto-deploy to GitLab!

The tutorials on orchid.run/ are the best place to start. The "Basic Usage Tutorials" are a good intro to the main concepts, and the "Advanced" ones are more condensed overviews of using Orchid for a specific purpose, and they all have sample projects to follow along with. I'd recommend starting with the Kotlin documentation tutorial, as it should give you a good idea of what you could do with Orchid.

And feel free to reach out on our Gitter Chat, I'd be more than happy to discuss further to see if Orchid meets your needs and to help you get started!

code of conduct - report abuse