daux.io/docs/_index.md

72 lines
1.8 KiB
Markdown
Raw Normal View History

<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.
2013-06-12 21:42:00 +02:00
</p>
2013-06-12 00:28:29 +02:00
2017-09-13 22:47:53 +02:00
---
### Features
---
<div class="Row">
<div class="Row__third">
2013-06-12 21:42:00 +02:00
2015-12-12 00:22:43 +01:00
#### 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)
2015-12-12 00:22:43 +01:00
</div>
<div class="Row__third">
2015-12-12 00:22:43 +01:00
#### For Developers
* [Auto Syntax Highlighting](01_Features/Auto_Syntax_Highlight.md)
* [Extend Daux.io with Processors](01_For_Developers/Creating_a_Processor.md)
2015-12-12 00:22:43 +01:00
* Full access to the internal API to create new pages programatically
* Work with pages metadata
</div>
<div class="Row__third">
2015-12-12 00:22:43 +01:00
#### For Marketing
2013-06-12 21:42:00 +02:00
* 100% Mobile Responsive
* 4 Built-In Themes or roll your own
* Functional, Flat Design Style
2015-12-12 00:22:43 +01:00
* Optional code float layout
2013-06-12 21:42:00 +02:00
* Shareable/Linkable SEO Friendly URLs
2015-07-19 16:36:59 +02:00
* Supports Google Analytics and Piwik Analytics
2015-12-12 00:22:43 +01:00
</div>
</div>
2013-06-12 21:42:00 +02:00
2017-09-13 22:47:53 +02:00
---
### Installation and usage
If you have __PHP__ and Composer installed
```bash
composer global require daux/daux.io
2017-09-13 22:47:53 +02:00
# 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
```
---