daux.io/docs/05_Configuration/_index.md

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.

**Table of contents**

[TOC]

### Title

Change the title bar in the docs

```json
{
    "title": "Daux.io"
}
```

### Tagline

Change the tagline bar in the docs

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

### Author

Change the documentation's author

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

### Image

An image to show on the landing page. A relative path from the documentation root.

```json
{
    "image": "image.png"
}
```

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

```json
{
    "format": "html"
}
```

-   **html** with [its options](./Html_export.md)
-   **confluence** with [its options](./Confluence_upload.md)

Available formats are **HTML** and **Confluence**

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

```json
{
    "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](http://php.net/manual/en/timezones.php).

```json
{
    "timezone": "America/Los_Angeles"
}
```

### Multi-language

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

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

Directory structure:

```
├── docs/
│   ├── _index.md
│   ├── en
│   │   ├── 00_Getting_Started.md
│   │   ├── 01_Examples
│   │   │   ├── 01_CommonMark_compliant.md
│   │   │   ├── 05_Code_Highlighting.md
│   │   ├── 05_More_Examples
│   │   │   ├── Hello_World.md
│   │   │   ├── 05_Code_Highlighting.md
│   ├── de
│   │   ├── 00_Getting_Started.md
│   │   ├── 01_Examples
│   │   │   ├── 01_CommonMark_compliant.md
│   │   │   ├── 05_Code_Highlighting.md
│   │   ├── 05_More_Examples
│   │   │   ├── Hello_World.md
│   │   │   ├── 05_Code_Highlighting.md
```

### Language

You can change the default language with the `language` option.

```json
{
    "language": "fr"
}
```

This will change the language of the text within Daux.io and also the `<html lang>` attribute.

You can override the translations with the `strings` option.
A string that isn't found will fall back to english.

```json
{
    "strings": {
        "fr": {
            "CodeBlocks_show": "Afficher le code",
            "Search_placeholder": "Rechercher...",
            "Link_previous": "Précédent",
            "Link_next": "Suivant",
            "Edit_on": "Editer sur :name:",
            "View_on_github": "Voir sur GitHub",
            "View_documentation": "Voir la Documentation"
        }
    }
}
```

### 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](!For_Developers/Creating_a_Processor).

```json
{
    "processor": "MyProcessor"
}
```
Big documentation improvements 2015-12-12 00:22:43 +01:00			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.

Reformat documentation 2020-04-25 14:44:43 +02:00			`Table of contents`
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00
			`[TOC]`

Big documentation improvements 2015-12-12 00:22:43 +01:00			`### Title`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`Change the title bar in the docs`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"title": "Daux.io"`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`}`
			```

			`### Tagline`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`Change the tagline bar in the docs`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"tagline": "The Easiest Way To Document Your Project"`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`}`
			```

			`### Author`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`Change the documentation's author`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"author": "Stéphane Goetz"`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`}`
			```

Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00			`### Image`
Reformat documentation 2020-04-25 14:44:43 +02:00
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00			`An image to show on the landing page. A relative path from the documentation root.`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"image": "image.png"`
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00			`}`
			```

			`### Format`
Reformat documentation 2020-04-25 14:44:43 +02:00
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00			`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`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"format": "html"`
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00			`}`
			```

Reformat documentation 2020-04-25 14:44:43 +02:00			`- html with [its options](./Html_export.md)`
			`- confluence with [its options](./Confluence_upload.md)`
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00
Reformat documentation 2020-04-25 14:44:43 +02:00			`Available formats are HTML and Confluence`
Improve documentation add missing examples, adds to #453 2017-05-16 22:24:28 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`### Ignore`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			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.

			```json
Clarify configuration options, put two spaces indents everywhere 2017-05-15 22:03:42 +02:00			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"ignore": {`
			`"files": ["Work_In_Progress.md"],`
			`"folders": ["99_Not_Ready"]`
			`}`
Clarify configuration options, put two spaces indents everywhere 2017-05-15 22:03:42 +02:00			`}`
Big documentation improvements 2015-12-12 00:22:43 +01:00			```

			`### Timezone`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`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](http://php.net/manual/en/timezones.php).`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"timezone": "America/Los_Angeles"`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`}`
			```

			`### Multi-language`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			Enables multi-language support which needs separate directories for each language in `docs/` folder.

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"languages": { "en": "English", "de": "German" }`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`}`
			```

			`Directory structure:`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			```
			`├── docs/`
			`│ ├── _index.md`
			`│ ├── en`
			`│ │ ├── 00_Getting_Started.md`
			`│ │ ├── 01_Examples`
Clarify which flavor of markdown is supported #460 2017-05-18 22:51:59 +02:00			`│ │ │ ├── 01_CommonMark_compliant.md`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`│ │ │ ├── 05_Code_Highlighting.md`
			`│ │ ├── 05_More_Examples`
			`│ │ │ ├── Hello_World.md`
			`│ │ │ ├── 05_Code_Highlighting.md`
			`│ ├── de`
			`│ │ ├── 00_Getting_Started.md`
			`│ │ ├── 01_Examples`
Clarify which flavor of markdown is supported #460 2017-05-18 22:51:59 +02:00			`│ │ │ ├── 01_CommonMark_compliant.md`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`│ │ │ ├── 05_Code_Highlighting.md`
			`│ │ ├── 05_More_Examples`
			`│ │ │ ├── Hello_World.md`
			`│ │ │ ├── 05_Code_Highlighting.md`
			```

Support translations for the UI, fixes #1 2017-10-19 22:18:46 +02:00			`### Language`

			You can change the default language with the `language` option.

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"language": "fr"`
Support translations for the UI, fixes #1 2017-10-19 22:18:46 +02:00			`}`
			```

			This will change the language of the text within Daux.io and also the `<html lang>` attribute.

			You can override the translations with the `strings` option.
			`A string that isn't found will fall back to english.`

			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"strings": {`
			`"fr": {`
			`"CodeBlocks_show": "Afficher le code",`
			`"Search_placeholder": "Rechercher...",`
			`"Link_previous": "Précédent",`
			`"Link_next": "Suivant",`
			`"Edit_on": "Editer sur :name:",`
			`"View_on_github": "Voir sur GitHub",`
			`"View_documentation": "Voir la Documentation"`
			`}`
Support translations for the UI, fixes #1 2017-10-19 22:18:46 +02:00			`}`
			`}`
			```

Big documentation improvements 2015-12-12 00:22:43 +01:00			`### Processor`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			`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](!For_Developers/Creating_a_Processor).`
Reformat documentation 2020-04-25 14:44:43 +02:00
Big documentation improvements 2015-12-12 00:22:43 +01:00			```json
			`{`
Reformat documentation 2020-04-25 14:44:43 +02:00			`"processor": "MyProcessor"`
Big documentation improvements 2015-12-12 00:22:43 +01:00			`}`
			```