wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-25 14:22:37 +03:00
Code Issues Projects Releases Wiki Activity
0f8146b212
wezterm/docs
History
Wez Furlong 0f8146b212
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: e4ae8a844d
2023-03-19 18:26:21 -07:00
..
cli add wezterm cli get-text command 2023-02-05 09:05:48 -07:00
colorschemes sync color schemes 2023-01-11 16:30:58 -07:00
config docs: shift from return {} style to config.something style 2023-03-19 18:26:21 -07:00
examples update derived files 2023-02-05 09:22:33 -07:00
install Update Homebrew section 2023-03-16 08:02:46 -07:00
javascript docs: switch doc build to Material for MkDocs 2023-03-15 19:22:51 -07:00
overrides/partials docs: switch doc build to Material for MkDocs 2023-03-15 19:22:51 -07:00
recipes docs: shell-integration: cover the new built-in user-vars 2023-01-23 10:50:49 -07:00
screenshots docs: command palette 2023-02-07 16:32:42 -07:00
_config.yml docs: switch to the "Hacker" theme which is darker 2019-12-18 09:25:36 -08:00
asciinema-player.css docs: use asciinema's web player for screenshots 2022-07-09 18:59:44 -07:00
asciinema-player.min.js docs: use asciinema's web player for screenshots 2022-07-09 18:59:44 -07:00
book.toml docs: add mdbook-admonish 2023-02-25 18:19:47 -07:00
changelog.md time: call_after accepts fractional seconds 2023-03-19 10:29:19 -07:00
contributing.md docs: switch doc build to Material for MkDocs 2023-03-15 19:22:51 -07:00
copymode.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
custom.css docs: css for https://github.com/wez/wezterm/pull/2911 2023-01-19 09:07:00 -07:00
escape-sequences.md fix: typo about parameter 2023-03-15 22:58:59 -07:00
faq.md docs: switch doc build to Material for MkDocs 2023-03-15 19:22:51 -07:00
features.md docs: fix video link on features page 2023-03-18 07:36:01 -07:00
help.md docs: upgrade to mdbook 0.4, enable link checking 2021-01-30 14:14:29 -08:00
hyperlinks.md improve default hyperlink_rules. add default_hyperlink_rules() 2023-03-16 20:44:15 -07:00
imgcat.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
index.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
installation.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
mdbook-admonish.css docs: add mdbook-admonish 2023-02-25 18:19:47 -07:00
mermaid-init.js docs: adopt mermaid-js for flowchart 2022-04-03 22:09:17 -07:00
mkdocs-base.yml docs: restore foo.html rather than foo/index.html style URLs 2023-03-17 11:47:59 -07:00
multiplexing.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
quickselect.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
README.markdown docs: redirect people from GH docs dir to website 2021-12-12 07:54:01 -07:00
scrollback.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
serial.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
shell-integration.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
ssh.md docs: some adjustments for mkdocs 2023-03-15 20:54:02 -07:00
style.css docs: shift from return {} style to config.something style 2023-03-19 18:26:21 -07:00
troubleshooting.md docs: add troubleshooting section 2023-01-19 10:44:05 -07:00
what-is-a-terminal.md Fix typo in "Terminal Emulators and PTYs" section 2023-02-19 07:06:57 -08:00

README.markdown

This directory contains the sources for the documentation. Read the generated documentation at: https://wezfurlong.org/wezterm