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

161 lines
3.7 KiB
Markdown
Raw Normal View History

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.
2020-04-25 14:44:43 +02:00
**Table of contents**
[TOC]
2015-12-12 00:22:43 +01:00
### Title
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
Change the title bar in the docs
```json
{
2020-04-25 14:44:43 +02:00
"title": "Daux.io"
2015-12-12 00:22:43 +01:00
}
```
### Tagline
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
Change the tagline bar in the docs
```json
{
2020-04-25 14:44:43 +02:00
"tagline": "The Easiest Way To Document Your Project"
2015-12-12 00:22:43 +01:00
}
```
### Author
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
Change the documentation's author
```json
{
2020-04-25 14:44:43 +02:00
"author": "Stéphane Goetz"
2015-12-12 00:22:43 +01:00
}
```
### Image
2020-04-25 14:44:43 +02:00
An image to show on the landing page. A relative path from the documentation root.
```json
{
2020-04-25 14:44:43 +02:00
"image": "image.png"
}
```
### Format
2020-04-25 14:44:43 +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
{
2020-04-25 14:44:43 +02:00
"format": "html"
}
```
2020-04-25 14:44:43 +02:00
- **html** with [its options](./Html_export.md)
- **confluence** with [its options](./Confluence_upload.md)
2020-04-25 14:44:43 +02:00
Available formats are **HTML** and **Confluence**
2015-12-12 00:22:43 +01:00
### Ignore
2020-04-25 14:44:43 +02:00
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
{
2020-04-25 14:44:43 +02:00
"ignore": {
"files": ["Work_In_Progress.md"],
"folders": ["99_Not_Ready"]
}
}
2015-12-12 00:22:43 +01:00
```
### Timezone
2020-04-25 14:44:43 +02:00
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
{
2020-04-25 14:44:43 +02:00
"timezone": "America/Los_Angeles"
2015-12-12 00:22:43 +01:00
}
```
### Multi-language
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
Enables multi-language support which needs separate directories for each language in `docs/` folder.
```json
{
2020-04-25 14:44:43 +02:00
"languages": { "en": "English", "de": "German" }
2015-12-12 00:22:43 +01:00
}
```
Directory structure:
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
```
├── docs/
│ ├── _index.md
│ ├── en
│ │ ├── 00_Getting_Started.md
│ │ ├── 01_Examples
│ │ │ ├── 01_CommonMark_compliant.md
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
│ │ │ ├── 01_CommonMark_compliant.md
2015-12-12 00:22:43 +01:00
│ │ │ ├── 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
{
2020-04-25 14:44:43 +02:00
"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
{
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"
}
}
}
```
2015-12-12 00:22:43 +01:00
### Processor
2020-04-25 14:44:43 +02:00
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).
2020-04-25 14:44:43 +02:00
2015-12-12 00:22:43 +01:00
```json
{
2020-04-25 14:44:43 +02:00
"processor": "MyProcessor"
2015-12-12 00:22:43 +01:00
}
```