From a433785302e0f45eac5fab515cc6b725949f1e9e Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sat, 9 Mar 2024 13:47:44 +0100 Subject: [PATCH] docs: add ToC to ui/web/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- ui/web/README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/ui/web/README.md b/ui/web/README.md index 55467852..250d0bd0 100644 --- a/ui/web/README.md +++ b/ui/web/README.md @@ -2,6 +2,22 @@ The Web UI code and configuration is in the repository directory [ui/web](./../../ui/web/). Commands execution is relative to that directory. +## Table of contents + +- [Project setup](#project-setup) + - [Configuration](#configuration) + - [Simulator UI Server Configuration](#simulator-ui-server-configuration) + - [Web UI configuration](#web-ui-configuration) + - [Unique UI server](#unique-ui-server) + - [Multiple UI servers](#multiple-ui-servers) + - [Run](#run) + - [Compiles and run for production](#compiles-and-run-for-production) + - [Preview locally](#preview-locally) + - [Development](#development) + - [Compiles and run for development](#compiles-and-run-for-development) + - [Formats files](#formats-files) + - [Lints and fixes files](#lints-and-fixes-files) + ## Project setup ### Configuration @@ -29,7 +45,7 @@ See [here](./../../README.md#charging-stations-simulator-configuration) for more Copy the configuration template [src/assets/config-template.json](./src/assets/config-template.json) to `public/config.json`. -##### Unique UI server: +##### Unique UI server ```json { @@ -48,7 +64,7 @@ Copy the configuration template [src/assets/config-template.json](./src/assets/c } ``` -##### Multiple UI servers: +##### Multiple UI servers ```json { @@ -84,13 +100,13 @@ Copy the configuration template [src/assets/config-template.json](./src/assets/c ### Run -#### Compiles for production and preview locally +#### Compiles and run for production ```shell pnpm preview ``` -#### Try it out +#### Preview locally You can now follow the link displayed in the terminal. The Web UI looks like the following: -- 2.34.1