home.md

@@ -35,6 +35,7 @@
 The frontend is mainly written in TypeScript and uses Vue3 to create a Single Page Application (SPA). If you want more information about the project itself you should have a look inside [Fluxio's documentation](https://git.h2t.iar.kit.edu/sw/armarx/core/fluxio/documentation) or the repository's [wiki](https://git.h2t.iar.kit.edu/sw/armarx/core/fluxio/frontend/-/wikis/home) page.
 
 ### Languages and tools
+
 #### Main languages and framework
 
 <p align="left">
@@ -83,48 +84,67 @@ The frontend is mainly written in TypeScript and uses Vue3 to create a Single Pa
 </p>
 
 ## As an Axii module
+
 ### Installation
+
 1. [Install Axii](https://git.h2t.iar.kit.edu/sw/armarx/meta/axii#installation) (can be skipped if you already have Axii installed)
 2. Create a workspace (can be skipped if you already have a workspace that you want to install the frontend in)
+
 ```sh
 axii workspace create
 ```
+
 3. Activate the newly created workspace
+
 ```sh
 axii workspace activate <workspace_name>
 ```
+
 4. Add fluxio/frontend as a dependency
+
 ```sh
 # For fluxio
 axii workspace add fluxio/frontend
 ```
+
 6. Upgrade your workspace
+
 ```sh
 axii workspace upgrade
 ```
+
 7. Fluxio should now be installed inside your workspace
-#### You can use the frontend with following commands:
+
+#### You can use the frontend with following commands
 
 Host the website locally on a server (if asked to install dependencies, answer with "y"):
 [ options: -h | --help, -p | --port, -u | --url ]
+
 ```sh
 fluxio run server
 ```
+
 Start the frontend in a dev environment (local server with hot reload):
 [ options: -h | --help, -p | --port, -u | --url ]
+
 ```sh
 fluxio run dev
 ```
+
 Build the frontend for production:
+
 ```sh
 fluxio build
 ```
+
 Update the npm packages used:
+
 ```sh
 fluxio install
 ```
 
 ### Troubleshooting
+
 - If there is no backend running already, you need to start the backend before you can use the frontend (the frontend will start without the backend but you will not be able to use anything that requires it)
 - In case the dev command is not working, you can use 'fluxio_frontend_run_server' to start the frontend (this will not use hot reload)
 - In case of issues with the npm dependencies, you can try to run 'fluxio_frontend_install' to update the dependencies. If this doesn't resolve the issue, please contact us.
@@ -151,6 +171,7 @@ Pull the Docker image:
 ``` sh
 docker pull git.h2t.iar.kit.edu:5050/sw/armarx/core/fluxio/frontend:latest
 ```
+
 </details>
 
 <details>
@@ -205,19 +226,21 @@ npm run dev
 
 #### Set up environment variables
 
-1. `VITE_API_BASE_URL=$URL` The base url for api requests. Default is http://localhost:3300/api/v1.  (replace $URL with the actual url)
-2. `PORT=$PORT` The port specifies the port for the frontend to run on. The frontend runs on http://localhost:5173 by default. (replace $PORT with an actual port number)
+1. `VITE_API_BASE_URL=$URL` The base url for api requests. Default is <http://localhost:3300/api/v1>.  (replace $URL with the actual url)
+2. `PORT=$PORT` The port specifies the port for the frontend to run on. The frontend runs on <http://localhost:5173> by default. (replace $PORT with an actual port number)
 
 #### Type-Check, compile and minify for production
 
 ```sh
 npm run build
 ```
+
 #### Setup SSH-Tunnel
 
 ````sh
 ssh -L 3000:localhost:3000 -J %r@jump.h2t.iar.kit.edu $USERNAME@pc105.h2t.iar.kit.edu
 ````
+
 replace $USERNAME with your ssh-username.
 
 #### Build documentation with [TypeDoc](https://typedoc.org/)