Prepped the rest of the documentation for launch

diff --git a/docs/configuration.md b/docs/configuration.md
index 4f97192727a1206ad6f6bce3fe71b0991886a0ee..584ee79c2af29a3aaf519451ac506f5dd642a2fc 100644 (file)
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -185,9 +185,12 @@ services:
         # background: red
 ```
 
-View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them.
+View [Custom Services](customservices.md) for details about all available custom
+services (like PiHole) and how to configure them.
 
-If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
+If you choose to fetch message information from an endpoint, the output format
+should be as follows (or you can
+[custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
 
 ```json
 {
@@ -197,43 +200,31 @@ If you choose to fetch message information from an endpoint, the output format s
 }
 ```
 
-`null` value or missing keys will be ignored and value from the `config.yml` will be used if available.
-Empty values (either in `config.yml` or the endpoint data) will hide the element (ex: set `"title": ""` to hide the title bar).
+`null` value or missing keys will be ignored and value from the `config.yml`
+will be used if available. Empty values (either in `config.yml` or the endpoint
+data) will hide the element (ex: set `"title": ""` to hide the title bar).
 
 ## Style Options
 
-Homer uses [Bulma CSS](https://bulma.io/), which provides a [modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll notice in the config there is a `tagstyle` option. It can be set to any of the bulma modifiers. You'll probably want to use one of these 4 main colors:
+Homer uses [Bulma CSS](https://bulma.io/), which provides a
+[modifiers syntax](https://bulma.io/documentation/modifiers/syntax/). You'll
+notice in the config there is a `tagstyle` option. It can be set to any of the
+bulma modifiers. You'll probably want to use one of these 4 main colors:
 
 - `is-info` (blue)
 - `is-success` (green)
 - `is-warning` (yellow)
 - `is-danger` (red)
 
-You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/) for other options regarding size, style, or state.
+You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers/syntax/)
+for other options regarding size, style, or state.
 
 ## PWA Icons
 
-In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used:
+In order to easily generate all required icon preset for the PWA to work, a tool
+like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator)
+can be used:
 
 ```bash
 npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
 ```
-
-## Supported services
-
-Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
-
-- PiHole
-- AdGuardHome
-- PaperlessNG
-- Mealie
-
-## Additional configuration
-
-### Paperless
-
-For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
-
-### Mealie
-
-First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.

diff --git a/docs/development.md b/docs/development.md
index a22ae0b2b6b648a25a5dd8a08ff2ed327d025c04..c02406b3cd521f219e0a4ffef0511658c52e8464 100644 (file)
--- a/docs/development.md
+++ b/docs/development.md
@@ -72,3 +72,32 @@ body #app.theme-my-awesome-theme. { ... }
 ...
 @import "./themes/my-awesome-theme.scss";
 ```
+
+
+## Documentation
+
+### Install Python dependencies
+
+Homer's documentation is built using
+[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). To get
+started, you'll need Python 3 installed on your machine and set up your local
+environment.
+
+```sh
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Preview local copy
+
+MkDocs comes with a command-line utility for building and serving the static
+documentation site every time you save a file. To launch it, run the `serve`
+command.
+
+```sh
+mkdocs serve
+```
+
+Your local version of the docs site will now be available at
+http://localhost:8000/.

diff --git a/docs/index.md b/docs/index.md
index 8ae670a49d1edc0c099784a6978f622a2bb7f816..737162ec793eb2f0689bd088813ac2513a51ca51 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -14,7 +14,7 @@ and serve!
 your hearts content using the long list of [configuration](/configuration)
 options available! Add links to all your relevant services and web apps,
 categorize them in groups, and in some cases,
-[get live status data](/custom_services) right there on your home page. Customize
-your home page with your own images and CSS to make it fit your style!
+[get live status data](/custom_services) right there on your home page.
+Customize your home page with your own images and CSS to make it fit your style!
 
 

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
index 649e5a61fc959d437e0a47ccd1c14dc159798b8c..1b29e95ab2060b929358fd19bb78d14ff947bbce 100644 (file)
--- a/docs/troubleshooting.md
+++ b/docs/troubleshooting.md
@@ -2,18 +2,29 @@
 
 ## My custom service card doesn't work, nothing appears or offline status is displayed (pi-hole, sonarr, ping, ...)
 
-You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) (Cross Origin Request Sharing) issue.
-It happens when the targeted service is hosted on a different domain or port.
-Web browsers will not allow to fetch information from a different site without explicit permissions (the targeted service
-must include a special `Access-Control-Allow-Origin: *` HTTP headers).
-If this happens your web console (`ctrl+shift+i` or `F12`) will be filled with this kind of errors:
+You might by facing a [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
+(Cross Origin Request Sharing) issue. It happens when the targeted service is
+hosted on a different domain or port. Web browsers will not allow to fetch
+information from a different site without explicit permissions (the targeted
+service must include a special `Access-Control-Allow-Origin: *` HTTP headers).
+If this happens your web console (`ctrl+shift+i` or `F12`) will be filled with
+this kind of errors:
 
 ```text
-Access to fetch at 'https://<target-service>' from origin 'https://<homer>' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.
+Access to fetch at 'https://<target-service>' from origin 'https://<homer>' has
+been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present
+on the requested resource. If an opaque response serves your needs, set the
+request's mode to 'no-cors' to fetch the resource with CORS disabled.
 ```
 
 To resolve this, you can either:
 
 * Host all your target service under the same domain & port.
-* Modify the target server configuration so that the response of the server included following header- `Access-Control-Allow-Origin: *` (<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests>). It might be an option in the targeted service, otherwise depending on how the service is hosted, the proxy or web server can seamlessly add it.
-* Use a cors proxy server like [`cors-container`](https://github.com/imjacobclark/cors-container), [`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others.
+* Modify the target server configuration so that the response of the server
+included following header- `Access-Control-Allow-Origin: *`
+(<https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#simple_requests>). It
+might be an option in the targeted service, otherwise depending on how the
+service is hosted, the proxy or web server can seamlessly add it.
+* Use a cors proxy server like
+[`cors-container`](https://github.com/imjacobclark/cors-container),
+[`cors-anywhere`](https://github.com/Rob--W/cors-anywhere) or many others.