Skip to content

Commit

Permalink
docs: Update list of currently available settings (neovide#2583)
Browse files Browse the repository at this point in the history
* docs: Update list of currently available settings

Not all of the settings were listed.
* Fork: important, as recent release changed the default behaviour and
command line option is worded differently; this documented only in code.
* Theme: another recently added option
* Font: just an example to better explain the expected format

* Reorder config options naturally in code and docs
  • Loading branch information
ekorchmar authored and zbyna committed Jun 1, 2024
1 parent a4671a7 commit 7c14070
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 15 deletions.
16 changes: 8 additions & 8 deletions src/settings/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,19 @@ pub fn config_path() -> PathBuf {
#[derive(Debug, Deserialize, Default, Clone)]
#[serde(rename_all = "kebab-case")]
pub struct Config {
pub wsl: Option<bool>,
pub no_multigrid: Option<bool>,
pub maximized: Option<bool>,
pub vsync: Option<bool>,
pub srgb: Option<bool>,
pub font: Option<FontSettings>,
pub fork: Option<bool>,
pub frame: Option<Frame>,
pub idle: Option<bool>,
pub maximized: Option<bool>,
pub neovim_bin: Option<PathBuf>,
pub frame: Option<Frame>,
pub no_multigrid: Option<bool>,
pub srgb: Option<bool>,
pub tabs: Option<bool>,
pub theme: Option<String>,
pub font: Option<FontSettings>,
pub title_hidden: Option<bool>,
pub tabs: Option<bool>,
pub vsync: Option<bool>,
pub wsl: Option<bool>,
}

#[derive(Debug, Clone, PartialEq)]
Expand Down
20 changes: 13 additions & 7 deletions website/docs/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,22 @@ There are two types of settings:
Settings currently available in the config file with default values:

```toml
wsl = false
no-multigrid = false
vsync = true
maximized = false
srgb = false
[font]
normal = [] # Will use the bundled Fira Code Nerd Font by default
size = 14.0

fork = false
frame = "full"
idle = true
maximized = false
neovim-bin = "/usr/bin/nvim" # in reality found dynamically on $PATH if unset
frame = "full"
title-hidden = true
no-multigrid = false
srgb = false
tabs = true
theme = "auto"
title-hidden = true
vsync = true
wsl = false
```

Settings from environment variables can be found in [Command Line Reference](command-line-reference.md),
Expand Down

0 comments on commit 7c14070

Please sign in to comment.