textwrap to wrap lines of texttracingstructopt to clapIt's usually this path:
$HOME/.config/wiki-tui/config.toml
Configuration is separated into the actual configuration and theming. The theme configuration +options can be found here.
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.
+If you are not familiar with toml, I 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 = ...
+page.toc.title = ...
and
-settings.toc.position = ...
+page.toc.position = ...
you can group them like this:
-[settings.toc]
+[page.toc]
title = ...
position = ...
-This is the recommended method because it makes your config easier to read for humans
+This is the recommended method because it makes your config easier to read, but it has no effect
+on the application
-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.
@@ -1071,7 +1073,7 @@ Configuration
- July 31, 2024
+ November 3, 2024
diff --git a/develop/configuration/keybindings/index.html b/develop/configuration/keybindings/index.html
index 333a4e9c..501c980d 100644
--- a/develop/configuration/keybindings/index.html
+++ b/develop/configuration/keybindings/index.html
@@ -16,8 +16,6 @@
-
-
@@ -834,11 +832,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -855,11 +853,32 @@
-
+
- Changing the Theme
+ Configuring the Pages
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Api Settings
@@ -1023,27 +1042,6 @@
-
-
-
-
-
-
-
-
-
-
-
- Table of Contents
-
-
-
-
-
-
-
-
-
diff --git a/develop/configuration/logging/index.html b/develop/configuration/logging/index.html
index 189e553d..cf226811 100644
--- a/develop/configuration/logging/index.html
+++ b/develop/configuration/logging/index.html
@@ -13,7 +13,7 @@
-
+
@@ -834,11 +834,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -855,11 +855,32 @@
-
+
- Changing the Theme
+ Configuring the Pages
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Api Settings
@@ -990,27 +1011,6 @@
-
-
-
-
-
-
-
-
-
-
-
- Table of Contents
-
-
-
-
-
-
-
-
-
diff --git a/develop/configuration/toc/index.html b/develop/configuration/page/index.html
similarity index 78%
rename from develop/configuration/toc/index.html
rename to develop/configuration/page/index.html
index ffef07f7..6714dd4f 100644
--- a/develop/configuration/toc/index.html
+++ b/develop/configuration/page/index.html
@@ -10,19 +10,21 @@
-
+
-
+
+
+
- Table of Contents - wiki-tui
+ Configuring the Pages - wiki-tui
@@ -57,11 +59,11 @@
-
+
-
+
@@ -69,15 +71,15 @@
-
+
-
+
-
+
@@ -100,7 +102,7 @@
-
+
Skip to content
@@ -152,7 +154,7 @@
- Table of Contents
+ Configuring the Pages
@@ -831,27 +833,6 @@
-
-
-
-
-
- Api Settings
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -871,69 +852,6 @@
-
-
-
-
-
-
-
- Configure the Logging
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Features
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Keybindings
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -950,7 +868,7 @@
- Table of Contents
+ Configuring the Pages
@@ -961,7 +879,7 @@
- Table of Contents
+ Configuring the Pages
@@ -983,79 +901,64 @@
-
-
+
- Changing the Title
+ Table of Contents Configuration
-
-
- -
-
+
-
-
- -
-
-
- Modify Item generation
-
-
-
@@ -1084,6 +978,90 @@
+
+
+
+
+
+
+
+
+
+
+
+ Api Settings
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Configure the Logging
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Features
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keybindings
+
+
+
+
+
+
+
+
+
@@ -1118,79 +1096,64 @@
@@ -1225,7 +1179,7 @@
-
+
@@ -1234,68 +1188,56 @@
-
+
-Table of Contents Configuration
-
-Info
-You can disable the table of contents
-
-Changing the Title
+Page Configuration
+In this page you can find all of the configuration options for the page. In the configuration file,
+this describes the [page] table.
+Table of Contents Configuration
+Disabling the Table of Contents
+ 0.5.0 · Default: true
+By settings this to false, the table of contents won't be displayed
+page.toc.enabled = false
+
+Changing the Title
0.5.1 ·
Default: default
The available title options for the table of contents are:
-default: uses the table of contents title given by the article (usually "Contents")article: uses the title of the current articlecustom: you can also define a custom titleDefault: uses the title ContentsArticle: uses the title of the current articleCustom: you can also define a custom title
-settings.toc.title = "default"
+page.toc.title = "Default"
With a custom title
-settings.toc.title = "custom"
-settings.toc.title_custom = "My Custom Title"
-
-Positioning the Table of Contents
- 0.5.1 ·
- Default: right
-Per default, the table of contents is on the right side of the screen. You can also have the table of contents be on the left side of the screen
-settings.toc.position = "left"
-
-Adjusting the width
-You can change the minimal and maximal width of the table of contents
-Minimal Width
- 0.5.1 ·
- Default: 20
-The minimal width of the table of contents (measured in characters)
-settings.toc.min_width = 20
+page.toc.title = { Custom = "My Custom Title" }
-Maximal Width
+Positioning the Table of Contents
0.5.1 ·
- Default: 60
-The maximal width of the table of contents (measured in characters)
-settings.toc.max_width = 60
+ Default: Right
+Per default, the table of contents is on the right side of the screen. You can also have the table
+of contents be on the left side of the screen
+page.toc.position = "Left"
-Disable Scrolling
-If don't want the scrolling (and the scrollbars) in your table of contents, you can disable it
-Horizontal Scrolling
- 0.5.1 ·
- Default: true
-Will disable horizontal scrolling (and the horizontal scrollbar) if set to false
-settings.toc.scroll_x = true
+Adjusting the width
+ 0.9.0 · Default 20
+You can change the percentage of the space the table of contents will occupy. The values are in
+percent (only whole numbers between 0 and 100 are allowed)
+page.toc.width_percentage = 20
-Vertical Scrolling
- 0.5.1 ·
+
Disable Scrolling
+ 0.9.0 ·
Default: true
-Will disable vertical scrolling (and the vertical scrollbar) if set to false
-settings.toc.scroll_y = true
+Will disable scrolling inside of the table of contents if set to false
+page.toc.enable_scrolling = true
-Modify Item generation
+Modify Item generation
0.5.1 ·
Default: {NUMBER} {TEXT}
If you don't like the look of the items in the table of contents, you can modify how these are generated. Available values are:
@@ -1303,13 +1245,13 @@ Modify Item generation
{NUMBER}: This is the current number of the header (for example: 1, 1.1, 1.2, 2, ...){TEXT}: The text (or content) of the header the item representssettings.toc.item_format = "{NUMBER} {TEXT}"
+page.toc.item_format = "{NUMBER} {TEXT}"
If you don't like the numbers at the beginning
-settings.toc.item_format = "{TEXT}"
+page.toc.item_format = "{TEXT}"
Or if you want to have a custom beginning
-settings.toc.item_format = "# {TEXT}"
+page.toc.item_format = "# {TEXT}"
@@ -1333,7 +1275,7 @@ Modify Item generation
- July 31, 2024
+ November 3, 2024
@@ -1343,7 +1285,7 @@ Modify Item generation
- August 11, 2022
+ November 3, 2024
diff --git a/develop/configuration/theme/index.html b/develop/configuration/theme/index.html
index 03275001..7473d9ad 100644
--- a/develop/configuration/theme/index.html
+++ b/develop/configuration/theme/index.html
@@ -13,10 +13,10 @@
-
+
-
+
@@ -831,27 +831,6 @@
-
-
-
-
-
-
-
- Api Settings
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -1078,11 +1057,11 @@
-
+
- Configure the Logging
+ Configuring the Pages
@@ -1099,11 +1078,11 @@
-
+
- Features
+ Api Settings
@@ -1120,11 +1099,11 @@
-
+
- Keybindings
+ Configure the Logging
@@ -1141,11 +1120,32 @@
-
+
- Table of Contents
+ Features
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keybindings
diff --git a/develop/contributing/bug-report/index.html b/develop/contributing/bug-report/index.html
index 3c4afa5d..16580573 100644
--- a/develop/contributing/bug-report/index.html
+++ b/develop/contributing/bug-report/index.html
@@ -887,11 +887,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -908,11 +908,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -929,11 +929,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -950,11 +950,11 @@
-
+
- Features
+ Configure the Logging
@@ -971,11 +971,11 @@
-
+
- Keybindings
+ Features
@@ -992,11 +992,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/contributing/developing/index.html b/develop/contributing/developing/index.html
index b0e096fd..33637e4c 100644
--- a/develop/contributing/developing/index.html
+++ b/develop/contributing/developing/index.html
@@ -887,11 +887,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -908,11 +908,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -929,11 +929,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -950,11 +950,11 @@
-
+
- Features
+ Configure the Logging
@@ -971,11 +971,11 @@
-
+
- Keybindings
+ Features
@@ -992,11 +992,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/contributing/feature-request/index.html b/develop/contributing/feature-request/index.html
index 0248fabc..31bbc359 100644
--- a/develop/contributing/feature-request/index.html
+++ b/develop/contributing/feature-request/index.html
@@ -887,11 +887,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -908,11 +908,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -929,11 +929,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -950,11 +950,11 @@
-
+
- Features
+ Configure the Logging
@@ -971,11 +971,11 @@
-
+
- Keybindings
+ Features
@@ -992,11 +992,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/contributing/index.html b/develop/contributing/index.html
index 51d0e456..b0480994 100644
--- a/develop/contributing/index.html
+++ b/develop/contributing/index.html
@@ -842,11 +842,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -863,11 +863,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -884,11 +884,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -905,11 +905,11 @@
-
+
- Features
+ Configure the Logging
@@ -926,11 +926,11 @@
-
+
- Keybindings
+ Features
@@ -947,11 +947,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/contributing/maintainers/index.html b/develop/contributing/maintainers/index.html
index 01889915..b5204470 100644
--- a/develop/contributing/maintainers/index.html
+++ b/develop/contributing/maintainers/index.html
@@ -933,11 +933,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -954,11 +954,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -975,11 +975,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -996,11 +996,11 @@
-
+
- Features
+ Configure the Logging
@@ -1017,11 +1017,11 @@
-
+
- Keybindings
+ Features
@@ -1038,11 +1038,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/getting-started/crash/index.html b/develop/getting-started/crash/index.html
index d1bba51f..c30f1c5f 100644
--- a/develop/getting-started/crash/index.html
+++ b/develop/getting-started/crash/index.html
@@ -818,11 +818,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -839,11 +839,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -860,11 +860,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -881,11 +881,11 @@
-
+
- Features
+ Configure the Logging
@@ -902,11 +902,11 @@
-
+
- Keybindings
+ Features
@@ -923,11 +923,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/getting-started/first-startup/index.html b/develop/getting-started/first-startup/index.html
index 6e4d2187..edfbfe9b 100644
--- a/develop/getting-started/first-startup/index.html
+++ b/develop/getting-started/first-startup/index.html
@@ -894,11 +894,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -915,11 +915,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -936,11 +936,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -957,11 +957,11 @@
-
+
- Features
+ Configure the Logging
@@ -978,11 +978,11 @@
-
+
- Keybindings
+ Features
@@ -999,11 +999,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/getting-started/installation/index.html b/develop/getting-started/installation/index.html
index 6e5f6d6c..7c718213 100644
--- a/develop/getting-started/installation/index.html
+++ b/develop/getting-started/installation/index.html
@@ -949,11 +949,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -970,11 +970,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -991,11 +991,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -1012,11 +1012,11 @@
-
+
- Features
+ Configure the Logging
@@ -1033,11 +1033,11 @@
-
+
- Keybindings
+ Features
@@ -1054,11 +1054,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/getting-started/license/index.html b/develop/getting-started/license/index.html
index 6fc316a2..20ba7c3b 100644
--- a/develop/getting-started/license/index.html
+++ b/develop/getting-started/license/index.html
@@ -843,11 +843,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -864,11 +864,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -885,11 +885,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -906,11 +906,11 @@
-
+
- Features
+ Configure the Logging
@@ -927,11 +927,11 @@
-
+
- Keybindings
+ Features
@@ -948,11 +948,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/getting-started/overview-keybindings/index.html b/develop/getting-started/overview-keybindings/index.html
index 5a87b924..bef1dbb1 100644
--- a/develop/getting-started/overview-keybindings/index.html
+++ b/develop/getting-started/overview-keybindings/index.html
@@ -894,11 +894,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -915,11 +915,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -936,11 +936,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -957,11 +957,11 @@
-
+
- Features
+ Configure the Logging
@@ -978,11 +978,11 @@
-
+
- Keybindings
+ Features
@@ -999,11 +999,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/getting-started/using-cli/index.html b/develop/getting-started/using-cli/index.html
index b26c4e02..282db4ee 100644
--- a/develop/getting-started/using-cli/index.html
+++ b/develop/getting-started/using-cli/index.html
@@ -912,11 +912,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -933,11 +933,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -954,11 +954,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -975,11 +975,11 @@
-
+
- Features
+ Configure the Logging
@@ -996,11 +996,11 @@
-
+
- Keybindings
+ Features
@@ -1017,11 +1017,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/index.html b/develop/index.html
index a18a31dc..da2b78ee 100644
--- a/develop/index.html
+++ b/develop/index.html
@@ -839,11 +839,11 @@
-
+
- Api Settings
+ Changing the Theme
@@ -860,11 +860,11 @@
-
+
- Changing the Theme
+ Configuring the Pages
@@ -881,11 +881,11 @@
-
+
- Configure the Logging
+ Api Settings
@@ -902,11 +902,11 @@
-
+
- Features
+ Configure the Logging
@@ -923,11 +923,11 @@
-
+
- Keybindings
+ Features
@@ -944,11 +944,11 @@
-
+
- Table of Contents
+ Keybindings
diff --git a/develop/sitemap.xml b/develop/sitemap.xml
index 0c1142a2..16914056 100644
--- a/develop/sitemap.xml
+++ b/develop/sitemap.xml
@@ -33,11 +33,11 @@
1980-01-01
- https://wiki-tui.net/develop/configuration/theme/
+ https://wiki-tui.net/develop/configuration/page/
1980-01-01
- https://wiki-tui.net/develop/configuration/toc/
+ https://wiki-tui.net/develop/configuration/theme/
1980-01-01
diff --git a/develop/sitemap.xml.gz b/develop/sitemap.xml.gz
index 1b5085ca..af9405e9 100644
Binary files a/develop/sitemap.xml.gz and b/develop/sitemap.xml.gz differ