Skip to content

Commit 741e3d5

Browse files
committed
Add base path note to README file
Signed-off-by: Sergio Castaño Arteaga <tegioz@icloud.com>
1 parent 9b50e32 commit 741e3d5

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,10 @@ One option to serve your landscape in production is to use a static site hosting
179179

180180
> [!NOTE]
181181
> The resulting website when building a landscape is a [single-page application](https://en.wikipedia.org/wiki/Single-page_application) that handles routing on the client side. This means that you'll need to configure your webserver to serve the `index.html` file for the SPA route paths (like '/guide', '/stats', etc). One way of doing this would be to serve that file when a non existent path is requested. The `serve` subcommand included in **landscape2** already handles this for us. In the GitHub pages example mentioned above, this is achieved by copying the content of the `index.html` file to the `404.html` file, which will be served when a non existent path is requested.
182+
> [!NOTE]
183+
> If you plan to host the generated landscape in a subpath instead of at the
184+
> root of your domain (for example `/landscape`), make sure to set the
185+
> `base_path` field in your `settings.yml` file accordingly.
182186
183187
### Validating data, settings and guide files
184188

0 commit comments

Comments
 (0)