doc: clearer exports.preview
Massimo Melina committed
May 20, 2024 at 18:48 UTC
43bd401829d855b0503917e9d11339a1a7c370d7
1 file changed
+2
-2
dev-plugins.md
+2
-2
@@ -49,7 +49,7 @@ All the following properties are optional unless otherwise specified.
49
- `isTheme: boolean | "light" | "dark"` set true if this is a theme that's not supposed to work together with other themes.
50
Running a theme will cause other themes to be stopped. Missing this, HFS will check if the name of the plugin ends with `-theme`.
51
Special values "light" and "dark" to declare the theme is (for example) dark and forces HFS to use dark-theme as a base.
52
-- `preview: string | string[]` one or more images you want to show before your plugin is downloaded.
52
+- `preview: string | string[]` one or more URLs to images you want to show before your plugin is downloaded. (JSON syntax)
53
- `depend: { repo: string, version: number }[]` declare what other plugins this depends on. (JSON syntax)
54
- `repo: string | object` pointer to a GitHub repo where this plugin is hosted. (JSON syntax)
55
- the string form is for GitHub repos. Example: "rejetto/file-icons"
@@ -73,7 +73,7 @@ All the following properties are optional unless otherwise specified.
73
Plugins with custom repos are not included in search results, but the update feature will still work.
74
75
WARNING: All the properties above are a bit special and must go in `exports` only (thus, not returned in `init`) and the syntax
76
-used must be strictly JSON (thus, no single quotes, only double quotes for strings and objects).
76
+used must be strictly JSON (thus, no single quotes, only double quotes for strings and objects), and must fit one line.
77
78
- `init` described in the previous section.
79
- `frontend_css: string | string[]` path to one or more css files that you want the frontend to load. These are to be placed in the `public` folder (refer below).