From 700377efd939172284666bbc4c7c561ef03d6376 Mon Sep 17 00:00:00 2001 From: Stefan Agner Date: Wed, 25 Oct 2023 11:51:35 +0200 Subject: [PATCH] Fix note markdown in add-on configuration section (#1955) --- docs/add-ons/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/add-ons/configuration.md b/docs/add-ons/configuration.md index 22964e86..4093dde8 100644 --- a/docs/add-ons/configuration.md +++ b/docs/add-ons/configuration.md @@ -117,7 +117,7 @@ image: repo/{arch}-my-custom-addon :::note Avoid using `config.yaml` as filename in your add-on for anything other than the add-on configuration. The Supervisor does a recursively search for `config.yaml` in the add-on repository. -:: +::: ### Required configuration options @@ -212,11 +212,11 @@ size: 15 count: 1.2 ``` -::note +:::note If you remove a configuration option from an add-on already deployed to users, it is recommended to delete the option to avoid a warning like `Option '' does not exist in the schema for ()`. To remove an option the Supervisor addons API can be used. Using bashio this boils down to `bashio::addon.option ''` (without additional argument to delete this option key). Typically this should be called inside an if block checking if the option is still set using `bashio::config.exists ''`. -:: +::: The `schema` looks like `options` but describes how we should validate the user input. For example: