explaingit

justinwalsh/daux.io

★ 4,533Audience · developerComplexity · 2/5Setup · easy

TLDR

A documentation generator that turns a folder of Markdown files into a browsable website with no build step, note: this repository is deprecated and all active development has moved to dauxio/daux.io.

Mindmap

mindmap
  root((daux.io))
    What it does
      Markdown to docs site
      Auto navigation
      No build step
    Tech stack
      PHP
      Markdown
    Use cases
      Project documentation
      Version-controlled docs
      Developer wikis
    Status
      Deprecated here
      Active at dauxio org
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Organize Markdown files into a folder structure and serve them as a navigable documentation website with no build step required.

USE CASE 2

Keep project docs as plain text files in your version control repo alongside code, letting Daux.io handle all the rendering.

USE CASE 3

Host lightweight developer documentation for a software project without a database or content management system.

Tech stack

PHPMarkdown

Getting it running

Difficulty · easy Time to first run · 5min

This repository is deprecated, go to dauxio/daux.io for active development, bug fixes, and support.

In plain English

Daux.io is a documentation generator that turns a folder of Markdown files into a formatted documentation website. Markdown is a plain-text format where you add simple symbols to indicate headings, bold text, lists, and links, making it easy to write readable content without touching HTML. Daux.io reads a folder structure you define, interprets the file organization as navigation, and renders the pages as a documentation site on the fly, meaning no separate build step is required to preview changes. The tool is aimed at developers who want a lightweight way to write and publish docs alongside a software project. Rather than managing a database-backed content management system or hand-coding a site, a team can keep documentation as plain text files in a version control repository, organized into folders that reflect the docs structure. Daux.io handles the rendering automatically. This particular repository (justinwalsh/daux.io) is deprecated and no longer receives updates. The project has moved to a new organization on GitHub called dauxio, where active development and support continue. The README here explicitly states that new issues and pull requests will be ignored. Anyone looking to use Daux.io or contribute to it should go to the new repository at dauxio/daux.io instead.

Copy-paste prompts

Prompt 1
How do I set up Daux.io (from the active dauxio/daux.io repo) to serve a folder of Markdown files as a documentation website locally?
Prompt 2
What folder naming conventions does Daux.io use to build the sidebar navigation from the file and directory structure?
Prompt 3
How do I customize the theme or color scheme of a Daux.io documentation site using its configuration file?
Open on GitHub → Explain another repo

← justinwalsh on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.