Configuration
Note from the Dev
I'm planning on overhauling the structure of the configuration. This includes but is not limited to:
- Changing the names of varius settings and parameters
- Organizing the configuration into a better thought out structure
This means that all of this is subject to change, however, it'll take a while for this to be "done".
We are also still in early development (pre 1.0), so expect breaking changes to occur every now and then. Always read the docs!
The path to the configuration file can be found by running this command
wiki-tui --config-path
It's usually this path:
$HOME/.config/wiki-tui/config.toml
It is written in toml and the following pages list all of the available configuration options. If you are not familiar with time, we suggest you read about the toml specification online.
One Quick Note about TOML
TOML lets you group options that are in the same table. It is suggested you group the options like this. For example, if you have the following options:
settings.toc.title = ...
and
settings.toc.position = ...
you can group them like this:
[settings.toc]
title = ...
position = ...
This is the recommended method because it makes your config easier to read for humans
Because wiki-tui is under active development, there will be many more configuration options. If you see any option on this page tagged with pre-release that means it hasn't been released yet and will be added on the next release.
Created: August 4, 2022