Fix inconsistent markdown formatting.

This changes all of the documentation markdown files to follow
the same rules. The rules I've applied are from
https://github.com/DavidAnson/markdownlint/blob/v0.25.1/doc/Rules.md

The reason I felt it was necessary
to change all the files was
that there were a lot inconsistencies in how the markdown was used.
Ranging from header levels to some headers having a new line before
content and some not.

docs/alternate-views.md

@@ -3,13 +3,15 @@
 ## Views
 
 Dashy has three different views:
+
 - Default View - This is the main homepage with sections in a grid layout
 - Workspace View - Items displayed on the side, and are launched within Dashy
 - Minimal View - A clean + simple tabbed view
 
 You can switch between views using the dropdown in the top-right corner. Set your chosen Starting View with `appConfig.startingView`. Click the page title at any time to go back to your selected starting view.
 
 ### Default
+
 This is the main page that you will land on when you first launch the application. Here all of your sections (with items + widgets) are visible in a grid layout.
 
 <p align="center">
@@ -18,6 +20,7 @@ This is the main page that you will land on when you first launch the applicatio
 </p>
 
 ### Workspace
+
 The workspace view displays your links in a sidebar on the left-hand side, and apps are launched inside an iframe without having to leave Dashy. This enables you to use all of your self-hosted apps from one place, and makes multi-tasking easy.
 
 You can specify a default app to be opened when you land on the workspace, by setting `appConfig.workspaceLandingUrl: https://app-to-open/`. If this app exists within your sections.items, then the corresponding section will also be expanded.
@@ -30,6 +33,7 @@ You can also opt to keep previously opened websites/ apps open in the background
 </p>
 
 ### Minimal View
+
 The minimal view aims to be super fast and simple, and can be used as a browser startpage. Items are grouped into a tab view, and the last opened tab will be remembered. Similar to the main view, you can search and launch items just by typing, and right-clicking will show more options (like open in modal, workspace or new tab).
 
 <p align="center">

docs/authentication.md

@@ -1,30 +1,33 @@
 # Authentication
 
 - [Basic Auth](#built-in-auth)
-	- [Setting Up Authentication](#setting-up-authentication)
-	- [Hash Password](#hash-password)
-	- [Logging In and Out](#logging-in-and-out)
-	- [Guest Access](#enabling-guest-access)
-	- [Per-User Access](#granular-access)
-	- [Security Considerations](#security)
+  - [Setting Up Authentication](#setting-up-authentication)
+  - [Hash Password](#hash-password)
+  - [Logging In and Out](#logging-in-and-out)
+  - [Guest Access](#enabling-guest-access)
+  - [Per-User Access](#granular-access)
+  - [Security Considerations](#security)
 - [Keycloak Auth](#keycloak)
   - [Deploying Keycloak](#1-deploy-keycloak)
   - [Setting up Keycloak](#2-setup-keycloak-users)
   - [Configuring Dashy for Keycloak](#3-enable-keycloak-in-dashy-config-file)
 - [Alternative Authentication Methods](#alternative-authentication-methods)
-	- [VPN](#vpn)
-	- [IP-Based Access](#ip-based-access)
-	- [Web Server Authentication](#web-server-authentication)
-	- [OAuth Services](#oauth-services)
-	- [Auth on Cloud Hosting Services](#static-site-hosting-providers)
+  - [VPN](#vpn)
+  - [IP-Based Access](#ip-based-access)
+  - [Web Server Authentication](#web-server-authentication)
+  - [OAuth Services](#oauth-services)
+  - [Auth on Cloud Hosting Services](#static-site-hosting-providers)
 
 ## Built-In Auth
+
 Dashy has a basic login page included, and frontend authentication. You can enable this by adding users to the `auth` section under `appConfig` in your `conf.yml`. If this section is not specified, then no authentication will be required to access the app, and it the homepage will resolve to your dashboard.
 
 ### Setting Up Authentication
+
 The `auth` property takes an array of users. Each user needs to include a username, hash and optional user type (`admin` or `normal`). The hash property is a [SHA-256 Hash](https://en.wikipedia.org/wiki/SHA-2) of your desired password.
 
 For example:
+
 ```yaml
 appConfig:
   auth:
@@ -37,18 +40,23 @@ appConfig:
 ```
 
 ### Hash Password
+
 Dashy uses [SHA-256 Hash](https://en.wikipedia.org/wiki/Sha-256), a 64-character string, which you can generate using an online tool, such as [this one](https://passwordsgenerator.net/sha256-hash-generator/) or [CyberChef](https://gchq.github.io/CyberChef/) (which can be self-hosted/ ran locally).
 
 A hash is a one-way cryptographic function, meaning that it is easy to generate a hash for a given password, but very hard to determine the original password for a given hash. This means, that so long as your password is long, strong and unique, it is safe to store it's hash in the clear. Having said that, you should never reuse passwords, hashes can be cracked by iterating over known password lists, generating a hash of each.
 
 ### Logging In and Out
+
 Once authentication is enabled, so long as there is no valid token in cookie storage, the application will redirect the user to the login page. When the user enters credentials in the login page, they will be checked, and if valid, then a token will be generated, and they can be redirected to the home page. If credentials are invalid, then an error message will be shown, and they will remain on the login page. Once in the application, to log out the user can click the logout button (in the top-right), which will clear cookie storage, causing them to be redirected back to the login page.
 
 ### Enabling Guest Access
+
 With authentication setup, by default no access is allowed to your dashboard without first logging in with valid credentials. Guest mode can be enabled to allow for read-only access to a secured dashboard by any user, without the need to log in. A guest user cannot write any changes to the config file, but can apply modifications locally (stored in their browser). You can enable guest access, by setting `appConfig.auth.enableGuestAccess: true`.
 
 ### Granular Access
+
 You can use the following properties to make certain sections or items only visible to some users, or hide sections and items from guests.
+
 - `hideForUsers` - Section or Item will be visible to all users, except for those specified in this list
 - `showForUsers` - Section or Item will be hidden from all users, except for those specified in this list
 - `hideForGuests` - Section or Item will be visible for logged in users, but not for guests
@@ -77,13 +85,15 @@ For Example:
 ```
 
 ### Permissions
+
 Any user who is not an admin (with `type: admin`) will not be able to write changes to disk.
 
 You can also prevent any user from writing changes to disk, using `preventWriteToDisk`. Or prevent any changes from being saved locally in browser storage, using `preventLocalSave`. Both properties can be found under [`appConfig`](./docs/configuring.md#appconfig-optional).
 
 To disable all UI config features, including View Config, set `disableConfiguration`.
 
 ### Security
+
 With basic auth, all logic is happening on the client-side, which could mean a skilled user could manipulate the code to view parts of your configuration, including the hash. If the SHA-256 hash is of a common password, it may be possible to determine it, using a lookup table, in order to find the original password. Which can be used to manually generate the auth token, that can then be inserted into session storage, to become a valid logged in user. Therefore, you should always use a long, strong and unique password, and if you instance contains security-critical info and/ or is exposed directly to the internet, and alternative authentication method may be better. The purpose of the login page is merely to prevent immediate unauthorized access to your homepage.
 
 **[⬆️ Back to Top](#authentication)**
@@ -119,21 +129,25 @@ You should now be able to access the Keycloak web interface, using the port spec
 ### 2. Setup Keycloak Users
 
 Before we can use Keycloak, we must first set it up with some users. Keycloak uses Realms (similar to tenants) to create isolated groups of users. You must create a Realm before you will be able to add your first user.
+
 1. Head over to the admin console
 2. In the top-left corner there is a dropdown called 'Master', hover over it and then click 'Add Realm'
 3. Give your realm a name, and hit 'Create'
 
 You can now create your first user.
+
 1. In the left-hand menu, click 'Users', then 'Add User'
 2. Fill in the form, including username and hit 'Save'
 3. Under the 'Credentials' tab, give the new user an initial password. They will be prompted to change this after first login
 
 The last thing we need to do in the Keycloak admin console is to create a new client
+
 1. Within your new realm, navigate to 'Clients' on the left-hand side, then click 'Create' in the top-right
 2. Choose a 'Client ID', set 'Client Protocol' to 'openid-connect', and for 'Valid Redirect URIs' put a URL pattern to where you're hosting Dashy (if you're just testing locally, then * is fine), and do the same for the 'Web Origins' field
 3. Make note of your client-id, and click 'Save'
 
 ### 3. Enable Keycloak in Dashy Config File
+
 Now that your Keycloak instance is up and running, all that's left to do is to configure Dashy to use it. Under `appConfig`, set `auth.enableKeycloak: true`, then fill in the details in `auth.keycloak`, including: `serverUrl` - the URL where your Keycloak instance is hosted, `realm` - the name you gave your Realm, and `clientId` - the Client ID you chose.
 For example:
 
@@ -151,10 +165,12 @@ appConfig:
 Note that if you are using Keycloak V 17 or older, you will also need to set `legacySupport: true` (also under `appConfig.auth.keycloak`). This is because the API endpoint was updated in later versions.
 
 ### 4. Add groups and roles (Optional)
+
 Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy.
 Keycloak server administration and configuration is a deep topic; please refer to the [server admin guide](https://www.keycloak.org/docs/latest/server_admin/index.html#assigning-permissions-and-access-using-roles-and-groups) to see details about creating and assigning roles and groups.
 Once you have groups or roles assigned to users you can configure access under each section or item `displayData.showForKeycloakUser` and `displayData.hideForKeycloakUser`.
 Both show and hide configurations accept a list of `groups` and `roles` that limit access. If a users data matches one or more items in these lists they will be allowed or excluded as defined.
+
 ```yaml
 sections:
   - name: DeveloperResources
@@ -181,6 +197,7 @@ From within the Keycloak console, you can then configure things like time-outs,
 ## Alternative Authentication Methods
 
 If you are self-hosting Dashy, and require secure authentication to prevent unauthorized access, then you can either use Keycloak, or one of the following options:
+
 - [Authentication Server](#authentication-server) - Put Dashy behind a self-hosted auth server
 - [VPN](#vpn) - Use a VPN to tunnel into the network where Dashy is running
 - [IP-Based Access](#ip-based-access) - Disallow access from all IP addresses, except your own
@@ -189,7 +206,9 @@ If you are self-hosting Dashy, and require secure authentication to prevent unau
 - [Password Protection (for cloud providers)](#static-site-hosting-providers) - Enable password-protection on your site
 
 ### Authentication Server
-##### Authelia
+
+#### Authelia
+
 [Authelia](https://www.authelia.com/) is an open-source full-featured authentication server, which can be self-hosted and either on bare metal, in a Docker container or in a Kubernetes cluster. It allows for fine-grained access control rules based on IP, path, users etc, and supports 2FA, simple password access or bypass policies for your domains.
 
 - `git clone https://github.com/authelia/authelia.git`
@@ -201,22 +220,28 @@ If you are self-hosting Dashy, and require secure authentication to prevent unau
 For more information, see the [Authelia docs](https://www.authelia.com/docs/)
 
 ### VPN
+
 A catch-all solution to accessing services running from your home network remotely is to use a VPN. It means you do not need to worry about implementing complex authentication rules, or trusting the login implementation of individual applications. However it can be inconvenient to use on a day-to-day basis, and some public and corporate WiFi block VPN connections. Two popular VPN protocols are [OpenVPN](https://openvpn.net/) and [WireGuard](https://www.wireguard.com/)
 
 ### IP-Based Access
+
 If you have a static IP or use a VPN to access your running services, then you can use conditional access to block access to Dashy from everyone except users of your pre-defined IP address. This feature is offered by most cloud providers, and supported by most web servers.
 
-##### Apache
+#### Apache
+
 In Apache, this is configured in your `.htaccess` file in Dashy's root folder, and should look something like:
-```
+
+```text
 Order Deny,Allow
 Deny from all
 Allow from [your-ip]
 ```
 
-##### NGINX
+#### NGINX
+
 In NGINX you can specify [control access](https://docs.nginx.com/nginx/admin-guide/security-controls/controlling-access-proxied-http/) rules for a given site in your `nginx.conf` or hosts file. For example:
-```
+
+```text
 server {
 	listen 80;
 	server_name www.dashy.example.com;
@@ -229,55 +254,68 @@ server {
   }
 ```
 
-##### Caddy
+#### Caddy
+
 In Caddy, [Request Matchers](https://caddyserver.com/docs/caddyfile/matchers) can be used to filter requests
-```
+
+```text
 dashy.site {
 	@public_networks not remote_ip [your-ip]
 	respond @public_networks "Access denied" 403
 }
 ```
 
 ### Web Server Authentication
+
 Most web servers make password protecting certain apps very easy. Note that you should also set up HTTPS and have a valid certificate in order for this to be secure.
 
-##### Apache
+#### Apache
+
 First crate a `.htaccess` file in Dashy's route directory. Specify the auth type and path to where you want to store the password file (usually the same folder). For example:
-```
+
+```text
 AuthType Basic
 AuthName "Please Sign into Dashy"
 AuthUserFile /path/dashy/.htpasswd
 require valid-user
 ```
 
 Then create a `.htpasswd` file in the same directory. List users and their hashed passwords here, with one user on each line, and a colon between username and password (e.g. `[username]:[hashed-password]`). You will need to generate an MD5 hash of your desired password, this can be done with an [online tool](https://www.web2generators.com/apache-tools/htpasswd-generator).  Your file will look something like:
-```
+
+```text
 alicia:$apr1$jv0spemw$RzOX5/GgY69JMkgV6u16l0
 ```
 
-##### NGINX
+#### NGINX
+
 NGINX has an [authentication module](https://nginx.org/en/docs/http/ngx_http_auth_basic_module.html) which can be used to add passwords to given sites, and is fairly simple to set up. Similar to above, you will need to create a `.htpasswd` file. Then just enable auth and specify the path to that file, for example:
-```
+
+```text
 location / {
   auth_basic "closed site";
   auth_basic_user_file conf/htpasswd;
 }
 ```
-##### Caddy
+
+#### Caddy
+
 Caddy has a [basic-auth](https://caddyserver.com/docs/caddyfile/directives/basicauth) directive, where you specify a username and hash. The password hash needs to be base-64 encoded, the [`caddy hash-password`](https://caddyserver.com/docs/command-line#caddy-hash-password) command can help with this. For example:
-```
+
+```text
 basicauth /secret/* {
 	alicia JDJhJDEwJEVCNmdaNEg2Ti5iejRMYkF3MFZhZ3VtV3E1SzBWZEZ5Q3VWc0tzOEJwZE9TaFlZdEVkZDhX
 }
 ```
 
 For more info about implementing a single sign on for all your apps with Caddy, see [this tutorial](https://joshstrange.com/securing-your-self-hosted-apps-with-single-signon/)
 
-##### Lighttpd
+#### Lighttpd
+
 You can use the [mod_auth](https://doc.lighttpd.net/lighttpd2/mod_auth.html) module to secure your site with Lighttpd. Like with Apache, you need to first create a password file listing your usersnames and hashed passwords, but in Lighttpd, it's usually called `.lighttpdpassword`.
 
 Then in your `lighttpd.conf` file (usually in the `/etc/lighttpd/` directory), load in the mod_auth module, and configure it's directives. For example:
-```
+
+```text
 server.modules += ( "mod_auth" )
 auth.debug = 2
 auth.backend = "plain"
@@ -296,12 +334,15 @@ $HTTP["host"] == "dashy.my-domain.net" {
   )
 }
 ```
+
 Restart your web server for changes to take effect.
 
 ### OAuth Services
+
 There are also authentication services, such as [Ory.sh](https://www.ory.sh/), [Okta](https://developer.okta.com/), [Auth0](https://auth0.com/), [Firebase](https://firebase.google.com/docs/auth/). Implementing one of these solutions would involve some changes to the [`Auth.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/Auth.js) file, but should be fairly straight forward.
 
 ### Static Site Hosting Providers
+
 If you are hosting Dashy on a cloud platform, you will probably find that it has built-in support for password protected access to web apps. For more info, see the relevant docs for your provider, for example: [Netlify Password Protection](https://docs.netlify.com/visitor-access/password-protection/), [Cloudflare Access](https://www.cloudflare.com/teams/access/), [AWS Cognito](https://aws.amazon.com/cognito/), [Azure Authentication](https://docs.microsoft.com/en-us/azure/app-service/scenario-secure-app-authentication-app-service) and [Vercel Password Protection](https://vercel.com/docs/platform/projects#password-protection).
 
 **[⬆️ Back to Top](#authentication)**