Documentation Site Generator

Posted on  by admin

This article presents a curated list with modern, open-source documentation generators useful when we want to explain in deep how a software product can be used by others.

All tools are free, actively supported and heavily used in production. Documenting a product software is a recommended practice even for small projects and becomes a necessity once the product is getting bigger (more modules, features) and used by many users.

Good documentation triggers a faster adoption of your product and might decrease the required LIVE support and 1-1 assistance with your users. MkDocs - Python based. Docsify - Vue based. Docute - Vue based. Vuepress - Vue based. Docusaurus - powered by React.

Enjoy the power of the latest web technologies – React, Webpack, modern JavaScript and CSS and more — all set up and waiting for you to start. Forget complicated deploys with databases and servers and their expensive, time-consuming setup costs, maintenance, and scaling fears. Docxy powered by Gatsby builds your site as "static" files which can be deployed easily on dozens of services. Do not build a website with last decade's tech. The future of the web is mobile, JavaScript and APIs — the JAMstack. Every website is a web app and every web app is a website. Docxy powered by Gatsby is the documentation generator you've been waiting for. Docxy is built with Gatsby. Gatsby is a static PWA (Progressive Web App) generator. You get code and data splitting out-of-the-box. Gatsby loads only the critical HTML, CSS, data, and JavaScript so your site loads as fast as possible. Once loaded, Gatsby prefetches resources for other pages so clicking around the site feels incredibly fast. Docxy is built with Gatsby. Gatsby builds the fastest possible website. Instead of waiting to generate pages when requested, pre-build pages and lift them into a global cloud of servers — ready to be delivered instantly to your users wherever they are.

This curated list with documentation generators might developers to write and maintain faster and easier the documentation for their products.

Docsify

Simple, Python-based documentation generator that uses Markdown format for input files - BSD-2-Clause License. Official information - MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation.

Documentation source files are written in Markdown, and configured with a single YAML configuration file.

11k Stars, 1.6k Forks, Latest commit 5days old.

You probably wouldn't have noticed it, but Docxy uses dark and light themes depending on the theme of user's system.