Daux.io – Markdown Documentation Generator

Daux.io is a documentation generator that turns a directory of Markdown files into a structured documentation website.

It is aimed at developers and project teams who want to keep documentation alongside source code while avoiding a database-backed content management system. The directory hierarchy becomes the site navigation, so organising documentation largely means organising folders and files. Daux.io can serve documentation locally while it is being written or generate a complete set of static files ready for deployment to a web server or static hosting service. Configuration is handled through JSON, with options for site identity, documentation paths, presentation and output behaviour.

This is free and open source software.

Key Features

• Uses CommonMark-compatible Markdown and supports Markdown tables.
• Automatically creates navigation from the documentation folder structure.
• Supports arbitrarily nested folders for multi-level documentation sets.
• Allows numeric filename prefixes to control sorting without exposing the numbers in generated navigation or URLs.
• Can create a dedicated landing page from an index.md file.
• Supports section landing pages as well as ordinary section index pages.
• Provides automatic syntax highlighting for code examples.
• Includes four built-in themes and supports custom themes.
• Generates responsive pages designed to work across different screen sizes.
• Can produce SEO-friendly, shareable URLs.
• Offers local serving for previewing documentation during editing.
• Generates static output that can be deployed to conventional web servers or static hosting platforms.
• Supports changing the source documentation path through configuration.
• Can integrate site analytics through supported analytics services.

Website: github.com/dauxio/daux.io
Support:
Developer: Stéphane Goetz, Justin Walsh
License: MIT License

Daux.io is written in PHP. Learn PHP with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

Explore our carefully curated directory of recommended free and open source software, covering every major software category. The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form.