daux.io/docs/_index.md

<p class="HeroText">
	<strong>Daux.io</strong> 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.
</p>

---

### Features

---

<div class="Row">
<div class="Row__third">

#### For Authors

-   [Auto Generated Navigation / Page sorting](01_Features/Navigation_and_Sorting.md)
-   [Internal documentation links](01_Features/Internal_links.md)
-   [CommonMark compliant](01_Features/CommonMark_compliant.md)
-   [Auto created homepage/landing page](01_Features/Landing_page.md)
-   [Multiple Output Formats](01_Features/Multiple_Output_Formats.md)
-   [Multiple Languages Support](01_Features/Multilanguage.md)
-   [No Build Step](01_Features/Live_mode.md)
-   [Static Output Generation](01_Features/Static_Site_Generation.md)
-   [Table of Contents](01_Features/Table_of_contents.md)

</div>
<div class="Row__third">

#### For Developers

-   [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)
-   [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)
-   Full access to the internal API to create new pages programatically
-   Work with pages metadata

</div>
<div class="Row__third">

#### 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

</div>
</div>

---

### Installation and usage

If you have **PHP** and Composer installed

```bash
composer global require daux/daux.io

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

Or if you wish to use **Docker**

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

---
Create a variables file to customize theme easily, lint CSS 2018-02-25 23:02:09 +01:00			`<p class="HeroText">`
Fix grammar mistake in sample index file 2016-05-04 16:19:24 +02:00			`<strong>Daux.io</strong> 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.`
Homepage design updates 2013-06-12 21:42:00 +02:00			`</p>`
Reworking the config 2013-06-12 00:28:29 +02:00
Document usage of docker 2017-09-13 22:47:53 +02:00			`---`

			`### Features`

			`---`

Create a variables file to customize theme easily, lint CSS 2018-02-25 23:02:09 +01:00			`<div class="Row">`
			`<div class="Row__third">`
Homepage design updates 2013-06-12 21:42:00 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`#### For Authors`

Reformat documentation 2020-04-25 14:44:43 +02:00			`- [Auto Generated Navigation / Page sorting](01_Features/Navigation_and_Sorting.md)`
			`- [Internal documentation links](01_Features/Internal_links.md)`
			`- [CommonMark compliant](01_Features/CommonMark_compliant.md)`
			`- [Auto created homepage/landing page](01_Features/Landing_page.md)`
			`- [Multiple Output Formats](01_Features/Multiple_Output_Formats.md)`
			`- [Multiple Languages Support](01_Features/Multilanguage.md)`
			`- [No Build Step](01_Features/Live_mode.md)`
			`- [Static Output Generation](01_Features/Static_Site_Generation.md)`
			`- [Table of Contents](01_Features/Table_of_contents.md)`
Big documentation improvements 2015-12-12 00:22:43 +01:00
			`</div>`
Create a variables file to customize theme easily, lint CSS 2018-02-25 23:02:09 +01:00			`<div class="Row__third">`
Big documentation improvements 2015-12-12 00:22:43 +01:00
			`#### For Developers`

Reformat documentation 2020-04-25 14:44:43 +02:00			`- [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)`
			`- [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)`
			`- Full access to the internal API to create new pages programatically`
			`- Work with pages metadata`
Big documentation improvements 2015-12-12 00:22:43 +01:00
			`</div>`
Create a variables file to customize theme easily, lint CSS 2018-02-25 23:02:09 +01:00			`<div class="Row__third">`
Big documentation improvements 2015-12-12 00:22:43 +01:00
			`#### For Marketing`
Homepage design updates 2013-06-12 21:42:00 +02:00
Reformat documentation 2020-04-25 14:44:43 +02:00			`- 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`
Big documentation improvements 2015-12-12 00:22:43 +01:00
			`</div>`
			`</div>`
Homepage design updates 2013-06-12 21:42:00 +02:00
Document usage of docker 2017-09-13 22:47:53 +02:00			`---`

			`### Installation and usage`

Reformat documentation 2020-04-25 14:44:43 +02:00			`If you have PHP and Composer installed`
Document usage of docker 2017-09-13 22:47:53 +02:00
			```bash
Fix references to composer package name, dauxio/daux.io -> daux/daux.io 2017-10-14 06:18:00 +02:00			`composer global require daux/daux.io`
Document usage of docker 2017-09-13 22:47:53 +02:00
			# Next to your `docs` folder, run
			`daux generate`
			```

Reformat documentation 2020-04-25 14:44:43 +02:00			`Or if you wish to use Docker`
Document usage of docker 2017-09-13 22:47:53 +02:00
			```bash
			# Next to your `docs` folder, run
			`docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate`
			```

			`---`