Best documentation generators in 2019

Sm0ke on June 21, 2019

Hello Coders, At some point, in order to improve our skills, we read the documentation provided by the underline technology. In this article, I a... [Read Full]
markdown guide
 

I've been building Orchid to be especially good for making a single website for both wiki-type prose documentation, and also API docs for your code. It also deploys your site automatically to Github Pages!

GitHub logo JavaEden / Orchid

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

Orchid

All Platforms Build Status 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

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.

It currently supports generating docs for Java, Kotlin, Groovy, and Swift; Ruby and Javascript are on the roadmap too. A recent update also added support for automatically pulling in wiki content from Github and Gitlab Wikis.

Here's a good intro to getting started with Orchid:

 
 

I am a huuge fan of AsciiDoc. The syntax is very similar to MarkDown, making the source easily readable. However it has a lot of extra features for rendering and composing source files so can be used to build all sorts of documents. You can render the same source into HTML, PDF, DocBook, and even a man-page format. Plus the tooling is available on CLI and in our Java Gradle projects using AsciiDoctorJ.

 

The post-processing translation to PDF, EPUB ... can be very useful.
I will add it to the list.
Also, feel free to share a documentation project, in the case is public.

 

Previously I choose docsify to create our dev guideline, it really easy to use and all javascript dev can use it with only need to install the package via npm.

 

Hello,
I've added docsify to the list. In case you have a public project somewhere built with Doscsify, please share it.

 
code of conduct - report abuse