wezterm/docs/config/lua/general.md

# Lua Reference

This section documents the various lua functions and types that are provided to
the configuration file.  These are provided by the `wezterm` module that must
be imported into your configuration file:

```lua
local wezterm = require 'wezterm'
local config = {}
config.font = wezterm.font 'JetBrains Mono'
return config
```
Fix some documentation pages (#3321) * Update ssh_backend.md * Update normalize_output_to_unicode_nfc.md * Update strikethrough_position.md * Update underline_position.md * Update underline_thickness.md * Fix lua config docs titles to be formatted as inline code * Mention how suggested alphabet for quick select is choosen * Mention update-status and update-right-status for status_update_interval * Fix docs for all keyassignments to be formatted as inline code * Fix Lua object index titles * Fix titles of `wezterm.` module index pages Fix title of `Color` object & `wezterm.color` functions We reduce titles from h2 to h1 because mkdocs defaults the page title to the page file name if no h1 header is found. * Unify title of all object methods * Add index page for Gui events 2023-03-22 16:36:03 +03:00			`# Lua Reference`
docs: Make it easier to split out docs into multiple pages 2020-10-10 08:03:59 +03:00
docs: start adding a reference section for Config 2021-01-19 04:31:39 +03:00			`This section documents the various lua functions and types that are provided to`
			the configuration file. These are provided by the `wezterm` module that must
			`be imported into your configuration file:`
docs: Make it easier to split out docs into multiple pages 2020-10-10 08:03:59 +03:00
			```lua
docs: apply stylua formatting refs: https://github.com/wez/wezterm/pull/2273 refs: https://github.com/wez/wezterm/issues/2253 2022-07-19 17:54:31 +03:00			`local wezterm = require 'wezterm'`
docs: shift from return {} style to config.something style Nudge new users towards using this style: ```lua local config = {} config.color_scheme = 'Batman' return config ``` and surface how to write lua modules closer to the main section on config files. In that lua modules section, nudge towards using a convention similar to that of the plugin spec described in this commit: e4ae8a844d8feaa43e1de34c5cc8b4f07ce525dd 2023-03-20 04:26:21 +03:00			`local config = {}`
			`config.font = wezterm.font 'JetBrains Mono'`
			`return config`
docs: Make it easier to split out docs into multiple pages 2020-10-10 08:03:59 +03:00			```