From 9997784873d52b0f2d00b74ba37817490e9aaa11 Mon Sep 17 00:00:00 2001 From: Glenn Slotte Date: Sun, 28 Jun 2020 22:00:28 +0200 Subject: [PATCH] docs: add section with layout configuration settings (#2037) --- docs/docs/configuration/settings.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/docs/configuration/settings.md b/docs/docs/configuration/settings.md index 1a8e9c04d4..0bbe26956d 100644 --- a/docs/docs/configuration/settings.md +++ b/docs/docs/configuration/settings.md @@ -39,7 +39,7 @@ The configuration file, `configuration.json` is in the Oni2 directory, whose loc - `editor.largeFileOptimizations` __(_bool_ default: `true`)__ - When `true`, Onivim will turn off certain settings like syntax highlighting for large files. -- `editor.lineNumbers` __(_"on"|"off"|"relative" _default: `"on"`)__ - Controls how line numbers are rendered on the editor surface +- `editor.lineNumbers` __(_"on"|"off"|"relative"_ default: `"on"`)__ - Controls how line numbers are rendered on the editor surface - _"on"_ - absolute line numbers are displayed - _"relative"_ - the absolute line number of the line with the cursor is displayed, other line numbers are shown relative. (This is helpful for motions in Vim!) - _"off"_ - do not render line numbers. @@ -72,6 +72,16 @@ The configuration file, `configuration.json` is in the Oni2 directory, whose loc - `workbench.tree.indent` __(_int_ default: `2`)__ - Indentation of the tree explorer. +## Layout + +- `workbench.editor.showTabs` __(_bool_ default: `true`)__ - When `false`, hides the editor tabs. + +- `oni.layout.showLayoutTabs` __(_"always"|"smart"|"never"_ default: `"smart"`)__ - Controls the display of layout tabs. `"smart"` will only show the tabs if there's more than one. + +- `oni.layout.layoutTabPosition` __(_"top"|"bottom"_ default: `"bottom"`)__ - Controls the position of the layout tabs. + +- `oni.layout.singleTabMode` __(_bool_ default: `false`)__ - When `true`, groups will only hold a single editor, and closing this editor will always close the group. It will also hide the editor tabs, and therefore essentially hide the concept of editor groups. + ## Rendering - `vsync` __(_bool_ default: `false`)__ - Whether rendering should sync with vertical retrace of the monitor. VSync adds input latency, as rendering must sync with the refresh rate of the monitor, but it reduces screen tearing.