aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKokaKiwi <kokakiwi+git@kokakiwi.net>2019-10-19 12:11:25 +0200
committerKokaKiwi <kokakiwi+git@kokakiwi.net>2019-10-19 12:15:16 +0200
commitdf3c2dfd8bed82121f3dcfba18105ce8ee5daddf (patch)
tree05f2deea4d5727033d21f47d005390df6a9b2366
parent638457ba94931c35268cf5fb4d2a432a0def6bdd (diff)
downloadpleroma-df3c2dfd8bed82121f3dcfba18105ce8ee5daddf.tar.gz
Add documentation for PWA manifest configuration.
-rw-r--r--docs/configuration/cheatsheet.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md
index 8d85276ed..3427ae419 100644
--- a/docs/configuration/cheatsheet.md
+++ b/docs/configuration/cheatsheet.md
@@ -247,6 +247,35 @@ relates to mascots on the mastodon frontend
* `default_mascot`: An element from `mascots` - This will be used as the default mascot
on MastoFE (default: `:pleroma_fox_tan`)
+## :manifest
+
+This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.
+
+* `icons`: Describe the icons of the app, this a list of maps describing icons in the same way as the
+ [spec](https://www.w3.org/TR/appmanifest/#imageresource-and-its-members) describes it.
+
+ Example:
+
+ ```elixir
+ config :pleroma, :manifest,
+ icons: [
+ %{
+ src: "/static/logo.png"
+ },
+ %{
+ src: "/static/icon.png",
+ type: "image/png"
+ },
+ %{
+ src: "/static/icon.ico",
+ sizes: "72x72 96x96 128x128 256x256"
+ }
+ ]
+ ```
+
+* `theme_color`: Describe the theme color of the app. (Example: `"#282c37"`, `"rebeccapurple"`)
+* `background_color`: Describe the background color of the app. (Example: `"#191b22"`, `"aliceblue"`)
+
## :mrf_simple
* `media_removal`: List of instances to remove medias from
* `media_nsfw`: List of instances to put medias as NSFW(sensitive) from