Merge pull request #506 from siralmat/main

Update live reload documentation

fasthtml/live_reload.py

@@ -47,7 +47,7 @@ class FastHTMLWithLiveReload(FastHTML):
         >>> app = FastHTMLWithLiveReload()
 
         Run:
-            run_uv()
+            serve()
     """
     LIVE_RELOAD_ROUTE = WebSocketRoute("/live-reload", endpoint=live_reload_websocket)
 

nbs/ref/live_reload.ipynb

@@ -30,7 +30,8 @@
     "**⚠️ Gotchas**\n",
     "- A reload is only triggered when you save your changes.\n",
     "- `FastHTMLWithLiveReload` should only be used during development.\n",
-    "- If your app spans multiple directories you might need to use the `--reload-dir` flag to watch all files in each directory. See the uvicorn [docs](https://www.uvicorn.org/settings/#development) for more info."
+    "- If your app spans multiple directories you might need to use the `--reload-dir` flag to watch all files in each directory. See the uvicorn [docs](https://www.uvicorn.org/settings/#development) for more info.\n",
+    "- The live reload script is only injected into the page when rendering [ft components](https://docs.fastht.ml/explains/explaining_xt_components.html)."
    ]
   },
   {

nbs/tutorials/by_example.ipynb

@@ -70,12 +70,7 @@
     "INFO:     Application startup complete.\n",
     "```\n",
     "\n",
-    "If you navigate to [http://127.0.0.1:8000](http://127.0.0.1:8000) in a browser, you'll see your \"Hello, World\". If you edit the `app.py` file and save it, the server will reload and you'll see the updated message when you refresh the page in your browser.  \n",
-    "\n",
-    ":::{.callout-tip}\n",
-    "# Live Reloading\n",
-    "You can also enable [live reloading](../ref/live_reload.ipynb) so you don't have to manually refresh your browser while editing it.\n",
-    ":::"
+    "If you navigate to [http://127.0.0.1:8000](http://127.0.0.1:8000) in a browser, you'll see your \"Hello, World\". If you edit the `app.py` file and save it, the server will reload and you'll see the updated message when you refresh the page in your browser."
    ]
   },
   {
@@ -197,7 +192,12 @@
    "source": [
     "This will render the HTML in the browser.\n",
     "\n",
-    "For debugging, you can right-click on the rendered HTML in the browser and select \"Inspect\" to see the underlying HTML that was generated. There you'll also find the 'network' tab, which shows you the requests that were made to render the page. Refresh and look for the request to `127.0.0.1` - and you'll see it's just a `GET` request to `/`, and the response body is the HTML you just returned."
+    "For debugging, you can right-click on the rendered HTML in the browser and select \"Inspect\" to see the underlying HTML that was generated. There you'll also find the 'network' tab, which shows you the requests that were made to render the page. Refresh and look for the request to `127.0.0.1` - and you'll see it's just a `GET` request to `/`, and the response body is the HTML you just returned.\n",
+    "\n",
+    ":::{.callout-tip}\n",
+    "# Live Reloading\n",
+    "You can also enable [live reloading](../ref/live_reload.ipynb) so you don't have to manually refresh your browser to view updates.\n",
+    ":::"
    ]
   },
   {