diff options
| author | Hayleigh Thompson <me@hayleigh.dev> | 2024-03-17 21:06:12 +0000 |
|---|---|---|
| committer | Hayleigh Thompson <me@hayleigh.dev> | 2024-03-17 21:06:12 +0000 |
| commit | 8d98b8d4bc103a3532fe994fe704396b60901e68 (patch) | |
| tree | e0ab3cabf9f5f97edfc5449dbbb92834804a3fb1 /pages | |
| parent | e485db0b4f53e56ab285dad799e78b32463122e3 (diff) | |
| download | lustre-8d98b8d4bc103a3532fe994fe704396b60901e68.tar.gz lustre-8d98b8d4bc103a3532fe994fe704396b60901e68.zip | |
:memo: Add CLI reference for --spa and --html flags.
Diffstat (limited to 'pages')
| -rw-r--r-- | pages/reference/cli.md | 15 |
1 files changed, 15 insertions, 0 deletions
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 + <script type="application/lustre"></script> + ``` + - `--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 |