diff options
| author |  vantezzen <hello@vantezzen.io> | 2020-03-13 09:47:09 +0100 |
|---|---|---|
| committer | vantezzen <hello@vantezzen.io> | 2020-03-13 09:47:09 +0100 |
| commit | cd5adf64fa89ab766961dc8468b19db906c93201 (patch) | |
| tree | 5a1997189274391f8307228267970b03435b7ac3 /docs | |
| parent | Improve integration guide (diff) | |
| download | ferdium-recipes-cd5adf64fa89ab766961dc8468b19db906c93201.tar.gz ferdium-recipes-cd5adf64fa89ab766961dc8468b19db906c93201.tar.zst ferdium-recipes-cd5adf64fa89ab766961dc8468b19db906c93201.zip | |
Fix heading hierarchy
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/integration.md b/docs/integration.md index fa05ee3..7b936aa 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
| @@ -14,10 +14,10 @@ A Ferdi recipe is basically nothing else than a node module and is currently ini | |||
| 14 | - [package.json](#packagejson) | 14 | - [package.json](#packagejson) |
| 15 | - [index.js](#indexjs) | 15 | - [index.js](#indexjs) |
| 16 | - [webview.js](#webviewjs) | 16 | - [webview.js](#webviewjs) |
| 17 | - [Icons](#icons) | 17 | - [Icons](#icons) |
| 18 | - [Dark Mode](#dark-mode) | 18 | - [Dark Mode](#dark-mode) |
| 19 | - [Debugging](#debugging) | 19 | - [Debugging](#debugging) |
| 20 | - [Publishing](#publishing) | 20 | - [Publishing](#publishing) |
| 21 | 21 | ||
| 22 | ## Installation | 22 | ## Installation |
| 23 | 1. To install a new recipe for testing, download the recipe folder e.g `whatsapp` or simply create an empty one with the name of your new recipe (we recommend using a recipe like `whatsapp` as a template though). | 23 | 1. To install a new recipe for testing, download the recipe folder e.g `whatsapp` or simply create an empty one with the name of your new recipe (we recommend using a recipe like `whatsapp` as a template though). |
| @@ -120,18 +120,18 @@ module.exports = (Ferdi) => { | |||
| 120 | 120 | ||
| 121 | To get more information about the provided functions, check the [API docs](frontend_api.md). | 121 | To get more information about the provided functions, check the [API docs](frontend_api.md). |
| 122 | 122 | ||
| 123 | ### Icons | 123 | ## Icons |
| 124 | In order to show every service icon crystal clear within the Ferdi UI, we require a .svg and .png in 1024x1024px. | 124 | In order to show every service icon crystal clear within the Ferdi UI, we require a .svg and .png in 1024x1024px. |
| 125 | 125 | ||
| 126 | ### Dark Mode | 126 | ## Dark Mode |
| 127 | You can provide a custom Dark Mode Theme for your recipes just by putting the `darkmode.css` into your recipe folder. Once the `darkmode.css` exists, you can enable the Dark Mode in your service settings. | 127 | You can provide a custom Dark Mode Theme for your recipes just by putting the `darkmode.css` into your recipe folder. Once the `darkmode.css` exists, you can enable the Dark Mode in your service settings. |
| 128 | 128 | ||
| 129 | Recipe Dark Mode is only supported by Ferdi 5.0.0-beta.19+ | 129 | Recipe Dark Mode is only supported by Ferdi 5.0.0-beta.19+ |
| 130 | 130 | ||
| 131 | ### Debugging | 131 | ## Debugging |
| 132 | In order to debug your service integration, open Ferdi and use the shortcut `Cmd/Ctrl+Alt+Shift+i` to open the recipes developer tools. | 132 | In order to debug your service integration, open Ferdi and use the shortcut `Cmd/Ctrl+Alt+Shift+i` to open the recipes developer tools. |
| 133 | 133 | ||
| 134 | ### Publishing | 134 | ## Publishing |
| 135 | Ferdi uses its recipe repository at <https://github.com/getferdi/recipes> to publish recipes to all clients. | 135 | Ferdi uses its recipe repository at <https://github.com/getferdi/recipes> to publish recipes to all clients. |
| 136 | 136 | ||
| 137 | > Our scripts are designed to work best on Linux and macOS systems. If you want to use these scripts on Windows, you may need to use [WSL](https://docs.microsoft.com/en-US/windows/wsl/install-win10) in order for the scripts to function correctly. If you have problems with packaging, please open a new issue at https://github.com/getferdi/recipes/issues/new and we can package your recipe for you. | 137 | > Our scripts are designed to work best on Linux and macOS systems. If you want to use these scripts on Windows, you may need to use [WSL](https://docs.microsoft.com/en-US/windows/wsl/install-win10) in order for the scripts to function correctly. If you have problems with packaging, please open a new issue at https://github.com/getferdi/recipes/issues/new and we can package your recipe for you. |