Configuration file

Basics

Documentable uses a JSON file to read custom configuration. You have three different options to specify it:

• Create a file named documentable.json in the same directory where documentable will be executed.

• Provide a custom path to a JSON file with the --conf option.

• Do nothing. In that case, the default configuration file will be used.

kinds entry

Array where each of the elements is written as:

{
    "kind": "a kind name (see Kind)",
    "display-text": "text to be displayed in the menu button",
    "sort": 1,
    "categories": [
        "name": "sort name to be used by Documentable",
        "display-text": "text to be displayed in the menu button"
    ]
}

• The value of kind must be the string format of one element of Kind.

• The values of name specified in categories have to be the same used in the metadata (see document-format).

• sort option is only available for Kind::Language, to sort the documents using the categories in one column.

Additional entries

{
    "title-page": "this string will appear in the tab",
    "pod-root-path": "link to the documentation dir",
    "url-prefix": "some string",
    "irc-link": "https://webchat.freenode.net/?channels=#raku"
}

• pod-root-path: Base link of the directory containing the documentation. It will be used to enable the edit button at the beginning of every primary page.

  For instance: "pod-root-path": "https://github.com/Raku/Documentable/tree/master/docs".