Docs tweaks

This commit is contained in:
shamoon 2024-06-17 22:17:28 -07:00
parent 11cc4a15cf
commit 0ee3e7153d
4 changed files with 26 additions and 36 deletions

View file

@ -55,25 +55,9 @@ export default widget;
All widgets that fetch data from dynamic endpoints should have either `mappings` or an `allowedEndpoints` property.
## Set up translation strings
## Including translation strings in your widget
Homepage uses translated and localized strings for **all text and numerical content** in widgets. English is the default language, and other languages can be added via [Crowdin](https://crowdin.com/project/gethomepage). To add the English translations for your widget, follow these steps:
Open the `public/locales/en/common.js` file.
Add a new object for your widget to the bottom of the list, like this:
```json
"yourwidget": {
"key1": "Value 1",
"key2": "Value 2",
"key3": "Value 3"
}
```
!!! note
Even if you nativly speak another language, you should only add English translations. You can then add translations in your native language via [Crowdin](https://crowdin.com/project/gethomepage), once your widget is merged.
Refer to the [translations guide](translations.md) for more details. The Homepage community prides itself on being multilingual, and we strongly encourage you to add translations for your widgets.
## Create the widget component