From 8d98b8d4bc103a3532fe994fe704396b60901e68 Mon Sep 17 00:00:00 2001 From: Hayleigh Thompson Date: Sun, 17 Mar 2024 21:06:12 +0000 Subject: :memo: Add CLI reference for --spa and --html flags. --- pages/reference/cli.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/pages/reference/cli.md b/pages/reference/cli.md index d02106e..52cb735 100644 --- a/pages/reference/cli.md +++ b/pages/reference/cli.md @@ -142,11 +142,26 @@ Flags: - `--host` - The host to serve the project on. Defaults to `0.0.0.0` and is accessible on localhosts and any other devices on the same network. +- `--spa` - Serve the `index.html` file for all routes. This is useful for single + page applications where the frontend handles routing. + +- `--html` - Provide a custom HTML file to serve. This is useful if you want to + include your own styles or scripts. + + To make sure the Lustre bundle can be loaded, you must include the following + script tag somewhere in your HTML file: + + ```html + + ``` + - `--use-lustre-ui` - Include the stylesheet from [lustre/ui](https://hexdocs.pm/lustre_ui/). This is mainly used in the example projects, but you may use this option to quickly experiment with the library yourself. + If the `--html` flag is provided, this flag will be ignored. + Example: ```sh -- cgit v1.2.3