-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #539 from squidowl/docs-v2
Book update
- Loading branch information
Showing
40 changed files
with
1,214 additions
and
447 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # `[buffer]` | ||
|
|
||
| A _buffer_ displays messages within a specific context. | ||
|
|
||
| Examples of buffers: | ||
|
|
||
| - Channel | ||
| - Server | ||
| - Private Query | ||
| - File transfer | ||
|
|
||
| Each buffer is shown inside a [pane](../pane/index.html). | ||
|
|
||
| ## Configuration | ||
|
|
||
| | Name | Description | | ||
| | --------------------------------------------------- | --------------------------------------------------------------- | | ||
| | [Channel](./channel/index.html) | Channel settings for when buffer context is a channel | | ||
| | [Internal Messages](./internal_messages/index.html) | Halloy specific status messages | | ||
| | [Nickname](./nickname.md) | Customize how nicknames are displayed within a buffer | | ||
| | [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 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # `[buffer.channel]` | ||
|
|
||
| A _channel_ represents a IRC channel. | ||
|
|
||
| Each channel is shown inside a [buffer](../index.html). | ||
|
|
||
| ## Configuration | ||
|
|
||
| | Name | Description | | ||
| | ------------------------- | -------------------------------------------------- | | ||
| | [Nicklist](./nicklist.md) | Customize the nicklist whitin a channel buffer | | ||
| | [Topic](./topic.md) | Customize the topic banner within a channel buffer | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # `[buffer.channel.nicklist]` | ||
|
|
||
| Customize the nicklist within a channel buffer. | ||
|
|
||
| **Example** | ||
|
|
||
| ```toml | ||
| [buffer.channel.nicklist] | ||
| color = "unique" | ||
| show_access_levels = true | ||
| ``` | ||
|
|
||
| ## `alignment` | ||
|
|
||
| Horizontal alignment of nicknames. | ||
|
|
||
| - **type**: string | ||
| - **values**: `"left"`, `"right"` | ||
| - **default**: `"left"` | ||
|
|
||
| ## `color` | ||
| Nickname colors in the nicklist. `"unique"` generates colors by randomizing the hue, while keeping the saturation and lightness from the theme's nickname color. | ||
|
|
||
| - **type**: string | ||
| - **values**: `"solid"`, `"unique"` | ||
| - **default**: `"unique"` | ||
|
|
||
| ## `enabled` | ||
|
|
||
| Control if nicklist should be shown or not by default. | ||
|
|
||
| - **type**: boolean | ||
| - **values**: `true`, `false` | ||
| - **default**: `true` | ||
|
|
||
| ## `position` | ||
|
|
||
| Nicklist position in the buffer. | ||
|
|
||
| - **type**: string | ||
| - **values**: `"left"`, `"right"` | ||
| - **default**: `"right"` | ||
|
|
||
|
|
||
| ## `show_access_levels` | ||
|
|
||
| Show access levels in front of nicknames (`@`, `+`, `~`, etc.). | ||
|
|
||
| - **type**: boolean | ||
| - **values**: `true`, `false` | ||
| - **default**: `true` | ||
|
|
||
| ## `width` | ||
|
|
||
| Overwrite nicklist width in pixels. | ||
|
|
||
| - **type**: integer | ||
| - **values**: any positive integer | ||
| - **default**: not set |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # `[buffer.channel.topic]` | ||
|
|
||
| Customize the topic banner within a channel buffer. | ||
|
|
||
| **Example** | ||
|
|
||
| ```toml | ||
| [buffer.channel.topic] | ||
| enabled = true | ||
| max_lines = 2 | ||
| ``` | ||
|
|
||
| ## `enabled` | ||
|
|
||
| Control if topic should be shown or not by default. | ||
|
|
||
| - **type**: boolean | ||
| - **values**: `true`, `false` | ||
| - **default**: `false` | ||
|
|
||
| ## `max_lines` | ||
|
|
||
| Amount of visible lines before you have to scroll in topic banner. | ||
|
|
||
| - **type**: integer | ||
| - **values**: any positive integer | ||
| - **default**: `2` |
Oops, something went wrong.