Orchid is a new Java/Kotlin framework for generating static documentation sites for any language or any purpose, and it definitely needs help organizing its docs. This is the first major project I've built, and I just don't know much about how to structure the docs pages and what to include in them to help people really figure this tool out.
A beautiful and truly unique documentation engine and static site generator.
Orchid
A beautiful and truly unique documentation engine and static site generator.
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 is a new Java/Kotlin framework for generating static documentation sites for any language or any purpose, and it definitely needs help organizing its docs. This is the first major project I've built, and I just don't know much about how to structure the docs pages and what to include in them to help people really figure this tool out.
A beautiful and truly unique documentation engine and static site generator.
Orchid
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.
…