Skip to content

Commit edab60b

Browse files
committed
docs: improve live reload docs
1 parent 16e5761 commit edab60b

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

lib/web_dev_utils/components.ex

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,17 @@ defmodule WebDevUtils.Components do
55
require EEx
66

77
@doc """
8-
A component for triggering live reloading via a websocket
8+
A component for triggering live reloading via a websocket.
9+
10+
The url for the websocket connectino is controlled by the `:reload_url` applicaiton config key.
11+
12+
## Example
13+
14+
```elixir
15+
# config/config.exs
16+
17+
config :web_dev_utils, :reload_url, "wss://sometunnelingdomain/ws"
18+
```
919
"""
1020
EEx.function_from_string(
1121
:def,

0 commit comments

Comments
 (0)