daux.io/docs/_index.md

Daux.io is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.

---

Features

---

For Authors

• Auto Generated Navigation / Page sorting
• Internal documentation links
• CommonMark compliant
• Auto created homepage/landing page
• Multiple Output Formats
• Multiple Languages Support
• No Build Step
• Static Output Generation
• Table of Contents

For Developers

• Auto Syntax Highlighting
• Extend Daux.io with Processors
• Full access to the internal API to create new pages programatically
• Work with pages metadata

For Marketing

• 100% Mobile Responsive
• 4 Built-In Themes or roll your own
• Functional, Flat Design Style
• Optional code float layout
• Shareable/Linkable SEO Friendly URLs
• Supports Google Analytics and Piwik Analytics

---

Installation and usage

If you have PHP and Composer installed

composer global require daux/daux.io

# Next to your `docs` folder, run
daux generate

Or if you wish to use Docker

# Next to your `docs` folder, run
docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate

---