Daux.io is an 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.
PHP CSS JavaScript Other
Permalink
Failed to load latest commit information.
bin Add the daux --serve command to simplify writing documentation and re… Jul 29, 2016
daux Applied fixes from StyleCI Jul 29, 2016
docker Add a docker-compose configuration to try to reproduce #386 Aug 5, 2016
docs Update documentation on UTF-8 Issues on Windows. Fixes #180 Jan 23, 2017
examples/multilanguage Fix multilanguage, make an example, fixes #416 Jan 10, 2017
libs Added a test for mailto: links Jan 23, 2017
templates Fix multilanguage, make an example, fixes #416 Jan 10, 2017
tests Added a test for mailto: links Jan 23, 2017
themes Update npm dependencies, use yarn Jan 9, 2017
tipuesearch Tweak search on mobile, fixes #432 Jan 23, 2017
.editorconfig Add an .editorconfig file Aug 23, 2014
.gitattributes Add a .gitattributes file Aug 23, 2014
.gitignore Improve readability of the theme, fixes #363 May 5, 2016
.htaccess Update htaccess Jul 20, 2015
.travis.yml Add badges and code coverage Jul 29, 2016
LICENSE Adding the MIT License Jul 19, 2013
README.md Add PHP Extension requirements, fixes #394 Aug 10, 2016
composer.json Allow to use Processors through the new CLI Nov 17, 2016
composer.lock Downgrade phpunit for php 5.5 Sep 26, 2016
daux.phar Compile latest daux.phar Aug 30, 2016
generate Add the daux --serve command to simplify writing documentation and re… Jul 29, 2016
global.json Tweak the default configuration Aug 16, 2016
gulpfile.js Update npm dependencies, use yarn Jan 9, 2017
index.php Applied fixes from StyleCI Jul 29, 2016
package.json Update npm dependencies, use yarn Jan 9, 2017
phpunit.xml First unit tests & TDD Refactoring Oct 27, 2015
serve Update documentation Jul 20, 2015
yarn.lock Update npm dependencies, use yarn Jan 9, 2017

README.md

Daux.io

Latest Version Software License Build Status Coverage Status Quality Score Total Downloads

Daux.io is an 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

  • 100% Mobile Responsive
  • Supports GitHub Flavored Markdown
  • Auto created homepage/landing page
  • Auto Syntax Highlighting
  • Auto Generated Navigation
  • 4 Built-In Themes or roll your own
  • Functional, Flat Design Style
  • Shareable/Linkable SEO Friendly URLs
  • Built On Bootstrap
  • No Build Step
  • Git/SVN Friendly
  • Supports Google Analytics and Piwik Analytics
  • Optional code float layout
  • Static Output Generation

Demos

This is a list of sites using Daux.io:

Do you use Daux.io? Send me a pull request or open an issue and I will add you to the list.

Install

composer global require justinwalsh/daux.io

You can then use the daux command line to generate your documentation.

If the command isn't found, ensure your $PATH contains ~/.composer/vendor/bin

Run on a server

Download this repository as a zip, unpack, and put your documentation in the docs folder, you can then serve it with Apache or Nginx.

daux

The command line tool has two commands: generate and serve, running Daux.io without an argument will automatically run the generate command.

You can run daux --help to get more details about each command.

Folders

By default, the generator will look for folders in the docs folder. Add your folders inside the docs folder. This project contains some example folders and files to get you started.

You can nest folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.

If you'd prefer to keep your docs somewhere else (like outside of the daux.io root directory) you can specify your docs path in the global.json file.

Files

The generator will look for Markdown files (*.md and *.markdown) inside the docs folder and any of the subfolders within docs.

You must use underscores instead of spaces. Here are some example file names and what they will be converted to:

Good:

  • 01_Getting_Started.md = Getting Started
  • API_Calls.md = API Calls
  • 200_Something_Else-Cool.md = Something Else-Cool
  • _5_Ways_to_Be_Happy.md = 5 Ways To Be Happy

Bad:

  • File Name With Space.md = FAIL

Sorting

To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. /docs/01_Hello_World.md and /docs/05_Features.md This will list Hello World before Features, overriding the default alpha-numeric sorting. The numbers will be stripped out of the navigation and urls. For the file 6 Ways to Get Rich, you can use /docs/_6_Ways_to_Get_Rich.md

Landing page

If you want to create a beautiful landing page for your project, simply create a index.md file in the root of the /docs folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this:

{
    "title": "Daux.io",
    "tagline": "The Easiest Way To Document Your Project",
    "image": "app.png"
}

Note: The image can be a local or remote image. Use the convention <base_url> to refer to the root directory of the Daux instance.

Section landing page

If you are interested in having a landing page for a subsection of your docs, all you need to do is add an index.md file to the folder. For example, /docs/01_Examples has a landing page for that section since there exists a /docs/01_Examples/index.md file. If you wish to have an index page for a section without a landing page format, use the name _index.md

Configuration

To customize the look and feel of your documentation, you can create a config.json file in the of the /docs folder. The config.json file is a simple JSON object that you can use to change some of the basic settings of the documentation.

Title:

Change the title bar in the docs

{
    "title": "Daux.io"
}

Themes:

We have 4 built-in Bootstrap themes. To use one of the themes, just set the theme option to one of the following:

  • daux-blue
  • daux-green
  • daux-navy
  • daux-red
{
  "html": {
    "theme": "daux-green"
  }
}

Custom Theme:

To use a custom theme, just copy over the theme folder as well as the .thm file for that theme into the themes directory and set its value in the theme param in config.json

{
    "theme": "new-theme",
}

Code Floating:

By default your code blocks will be floated to a column on the right side of your content. To disable this feature, set the float property to false.

{
    "float": false
}

Toggling Code Blocks

Some users might wish to hide the code blocks & view just the documentation. By setting the toggle_code property to true, you can offer a toggle button on the page.

{
    "toggle_code": true
}

GitHub Repo:

Add a 'Fork me on GitHub' ribbon.

{
    "repo": "justinwalsh/daux.io"
}

Twitter:

Include twitter follow buttons in the sidebar.

{
    "twitter": ["justin_walsh", "todaymade"]
}

Links:

Include custom links in the sidebar.

{
    "links": {
        "GitHub Repo": "https://github.com/justinwalsh/daux.io",
        "Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
        "Made by Todaymade": "http://todaymade.com"
    }
}

Google Analytics:

This will embed the google analytics tracking code.

{
    "google_analytics": "UA-XXXXXXXXX-XX"
}

Piwik Analytics:

This will embed the piwik tracking code.

{
    "piwik_analytics": "my-url-for-piwik.com"
}

You can Also give a specific Piwik ID as well.

{
    "piwik_analytics_id": "43"
}

Ignore:

Set custom files and entire folders to ignore within your /docs folder. For files make sure to include the file extension in the name. For both files and folders, names are case-sensitive.

    {
        "ignore": {
            "files": ["Work_In_Progress.md"],
            "folders": ["99_Not_Ready"]
        }
    }

Breadcrumb titles

Daux.io provides the option to present page titles as breadcrumb navigation. You can optionally specify the separator used for breadcrumbs.

{
        "breadcrumbs": true,
        "breadcrumb_separator" : " > "
}

Date Modified

By default, daux.io will display the last modified time as reported by the system underneath the title for each document. To disable this, change the option in your config.json to false.

{
    "date_modified": false
}

Timezone

If your server does not have a default timezone set in php.ini, it may return errors when it tries to generate the last modified date/time for docs. To fix these errors, specify a timezone in your config file. Valid options are available in the PHP Manual.

{
        "timezone": "America/Los_Angeles"
}

Inherit Index

This feature will instructs the navigation generator to seek the first available file to use when there is no index in a folder.

{
        "html": {
            "inherit_index": true
        }
}

Multi-language

Enables multi-language support which needs seperate directories for each language in docs/ folder.

{
        "languages": { "en": "English", "de": "German" }
}

Directory structure:

├── docs/
│   ├── index.md
│   ├── en
│   │   ├── 00_Getting_Started.md
│   │   ├── 01_Examples
│   │   │   ├── 01_GitHub_Flavored_Markdown.md
│   │   │   ├── 05_Code_Highlighting.md
│   │   ├── 05_More_Examples
│   │   │   ├── Hello_World.md
│   │   │   ├── 05_Code_Highlighting.md
│   ├── de
│   │   ├── 00_Getting_Started.md
│   │   ├── 01_Examples
│   │   │   ├── 01_GitHub_Flavored_Markdown.md
│   │   │   ├── 05_Code_Highlighting.md
│   │   ├── 05_More_Examples
│   │   │   ├── Hello_World.md
│   │   │   ├── 05_Code_Highlighting.md

Running Remotely

Copy the files from the repo to a web server that can run PHP 5.4 or greater.

Running Locally

There are several ways to run the docs locally. You can use something like MAMP or WAMP. If you are like me and use alot of Node.js and Grunt.js, then you can use the optional grunt command I have packaged with the project which will start a PHP web server for you in the project folder.

The Grunt.js task uses the built in web server in PHP 5.4 to host the docs on your local machine. This is really only intended be used when you are writing/updating a ton of docs and want to preview the changes locally.

To use the optional Grunt command you will need:

  • Node.js
  • npm
  • Grunt.js
  • PHP 5.5 or greater

This project contains a package.json file, so once you have the requirements installed, you can simply run a npm install and then grunt in the projects folder to start the local web server. By default the server will run at: http://localhost:8085

Generating a set of static files

These can be uploaded to a static site hosting service such as pages.github.com

Generating a complete set of pages, with navigation

daux --source=docs --destination=static

Running on IIS

If you have set up a local or remote IIS web site, you may need a web.config with:

  • A rewrite configuration, for handling clean urls.
  • A mime type handler for less files, if using a custom theme.

Clean URLs

The web.config needs an entry for <rewrite> under <system.webServer>:

<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                <rule name="Main Rule" stopProcessing="true">
                    <match url=".*" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.php" appendQueryString="false" />
                </rule>
            </rules>
        </rewrite>
    </system.webServer>
</configuration>

To use clean URLs on IIS 6, you will need to use a custom URL rewrite module, such as URL Rewriter.

Docker

A docker configuration is also provided to run daux within a container, you can either run daux with php5 or php7.

cd docker
docker-compose -f docker-compose.7.yml up -d

You can then point your browser to http://localhost:8086

PHP Requirements

Daux.io is compatible with PHP 5.5 and up.

The reason is because some dependencies we have (mainly Symfony and Guzzle) do not support php 5.4 anymore.

Extensions

PHP Needs the following extension to work : php-mbstring and php-xml.

If you encounter an error similar to utf8_decode() not found this means that you're missing the php-xml package. (We've seen it happen only on PHP 7)

Support

If you need help using Daux.io, or have found a bug, please create an issue on the GitHub repo.