Merge pull request #659 from squidowl/chore/chathistory/book

squidowl · Nov 21, 2024 · 5813d89 · 5813d89
2 parents 57c1d3b + 4da02c8
commit 5813d89
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -39,6 +39,7 @@
       - [Topic](configuration/buffer/server_messages/topic.md)
     - [Text Input](configuration/buffer/text_input.md)
     - [Timestamp](configuration/buffer/timestamp.md)
+    - [Chat History](configuration/buffer/chat_history.md)
   - [File Transfer](configuration/file_transfer/README.md)
     - [Server](configuration/file_transfer/server.md)
   - [Font](configuration/font.md)

diff --git a/book/src/configuration/buffer/README.md b/book/src/configuration/buffer/README.md
@@ -21,3 +21,4 @@ Each buffer is shown inside a [pane](../pane/index.html).
 | [Server Messages](./server_messages/index.html)     | Settings for server messages such as `join`, `part`, `quit` etc |
 | [Text Input](./text_input.md)                       | Customize the text input for a buffer                           |
 | [Timestamp](./timestamp.md)                         | Customize how timestamps are displayed within a buffer          |
+| [Chat History](./chat_history.md)                   | Customize IRCv3 Chat History extension          |
diff --git a/book/src/configuration/buffer/chat_history.md b/book/src/configuration/buffer/chat_history.md
@@ -0,0 +1,18 @@
+# `[buffer.chathistory]`
+
+Customize IRCv3 Chat History extension
+
+**Example**
+
+```toml
+[buffer.chathistory]
+infinite_scroll = true
+```
+
+## `infinite_scroll`
+
+Automatically request older history when scrolling to the top of a channel/query buffer
+
+- **type**: boolean
+- **values**: `true`, `false`
+- **default**: `false`
diff --git a/book/src/configuration/servers/README.md b/book/src/configuration/servers/README.md
@@ -256,4 +256,12 @@ Example: `["Foo", "Bar"]`
 - **values**: array of any strings
 - **default**: not set
 
+## `chathistory`
+
+Whether or not to enable [IRCv3 Chat History](https://ircv3.net/specs/extensions/chathistory) (if it is supported by the server).
+
+- **type**: boolean
+- **values**: `true`, `false`
+- **default**: `true`
+
 [^1]: Shell expansions (e.g. `"~/"` → `"/home/user/"`) are not supported in path strings.