2013-06-12 21:42:00 +02:00
< p class = "lead" >
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.
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
---
2015-12-12 00:22:43 +01:00
< div class = row >
2016-05-23 20:09:15 +02:00
< div class = col-third >
2013-06-12 21:42:00 +02:00
2015-12-12 00:22:43 +01:00
#### For Authors
2016-07-04 20:33:44 +02:00
* [Auto Generated Navigation / Page sorting ](01_Features/Navigation_and_Sorting.md )
* [Internal documentation links ](01_Features/Internal_links.md )
2017-05-18 22:51:59 +02:00
* [CommonMark compliant ](01_Features/CommonMark_compliant.md )
2016-07-04 20:33:44 +02:00
* [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 >
2016-05-23 20:09:15 +02:00
< div class = col-third >
2015-12-12 00:22:43 +01:00
#### For Developers
2016-07-04 20:33:44 +02:00
* [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 >
2016-05-23 20:09:15 +02:00
< div class = col-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 dauxio/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
```
---
2013-07-24 15:29:32 +02:00
<!-- Google Code -->
< script type = "text/javascript" >
var google_conversion_id = 983836026;
var google_custom_params = window.google_tag_params;
var google_remarketing_only = true;
< / script >
2014-07-12 12:31:57 +02:00
2013-07-24 15:29:32 +02:00
< script type = "text/javascript" src = "//www.googleadservices.com/pagead/conversion.js" >
< / script >
< noscript >
< div style = "display:inline;" >
< img height = "1" width = "1" style = "border-style:none;" alt = "" src = "//googleads.g.doubleclick.net/pagead/viewthroughconversion/983836026/?value=0&guid=ON&script=0" / >
< / div >
2015-04-22 18:24:10 +02:00
< / noscript >