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 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"
}

Tagline

Change the tagline bar in the docs

{
    "tagline": "The Easiest Way To Document Your Project"
}

Author

Change the documentation's author

{
    "author": "Stéphane Goetz"
}

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"]
        }
    }

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"
}

Multi-language

Enables multi-language support which needs separate 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

Format

Change the output format. It is recommended you set only formats that support the live mode as this will also be read by the integrated web server. And you set the other formats (like confluence) only by command line

{
    "format": "html"
}

Processor

You can set the processor in the documentation or as an option to the command line. If you need it when running the server, you should add it to the configuration.

More information on how to create a Processor can be found here.

{
    "processor": "MyProcessor"
}