Reduce number of markdown linter warnings for ui README

Issue-ID: PORTALNG-113
Change-Id: Ic2223dfe01df0115b58f07f2dfe114d6ba04030c
Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>

diff --git a/README.md b/README.md
index 0e133c9..40e0084 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,9 +7,11 @@ The portal-ng ui can either be developed against a remote cluster or it's depend
 To develop against a remote cluster, the webpack proxy needs to be configured to forward requests to the remote cluster urls.
 For that we are providing a `staging.proxy.config.json.template` file that needs to be adjusted with your cluster hostnames and then saved as `staging.proxy.config.json`.
 After that, you can either use `npm start` or the `staging.sh` to launch the portal-ng in development mode:
+
 ```sh
 ./staging.sh
 ```
+
 ```sh
 npm start
 ```
@@ -18,13 +20,14 @@ npm start
 We are providing a docker-compose file that can be used to spin up the portal-ng and it's dependencies (like Keycloak or the bff) on your machine.
 
 To do that, execute the `run.sh` in the development folder:
-```shell
+
+```sh
 development/run.sh
 ```
 
 To stop the portal-ng, portal backend services, Keycloak and the databases run:
 
-```shell
+```sh
 development/stop.sh
 ```
 
@@ -35,21 +38,24 @@ You can access the portal-ng UI via browser with different default user accounts
 in what they are allowed to see in the portal.
 
 URL: http://localhost
-```
-username: onap-admin  
+
+``` yaml
+username: onap-admin
 password: password
 
-username: onap-designer  
+username: onap-designer
 password: password
 
-username: onap-operator  
+username: onap-operator
 password: password
 ```
+
 You can access the Keycloak UI via browser.
 
 URL: http://localhost:8080
-```
-username: admin  
+
+``` yaml
+username: admin
 password: password
 ```
 
@@ -60,7 +66,7 @@ Run `npm run build -- --prod --base-href=/portal-ui/` to get a production build
 
 In the configuration of nginx (the `nginx.template`) we have a few environment variables that need to be set.
 
-```bash
+```sh
 export NGINX_PORT=80
 export BFF_URL=http://bff:9080/
 export WIREMOCK_URL=http://wiremock:8080/
@@ -68,14 +74,16 @@ export WIREMOCK_URL=http://wiremock:8080/
 
 Finally, build the image with
 
-```bash
+```sh
 docker build -t portal-ng .
 ```
 
 ### Run the docker image
 
-```bash
+```sh
 docker run -e "NGINX_PORT=80" -e "BFF_URL=http:bff:9080/" -e "WIREMOCK_URL=http://wiremock:8080/" -p 8080:80 portal-ng
 ```
 
-Note that this will not work on its own, because the referenced containers (`BFF` and `WIREMOCK`) are most likely not available in your local environment. You would have to run them as well, or pass in other urls (like `example.com`) to get the container running locally. Obviously this does not get you very far though.
+Note that this will not work on its own, because the referenced containers (`BFF` and `WIREMOCK`) are most likely not available in your local environment.
+You would have to run them as well, or pass in other urls (like `example.com`) to get the container running locally.
+Obviously this does not get you very far though.