diff --git a/developer/docs/help/context/package-editor.md b/developer/docs/help/context/package-editor.md index 38026732bc..85335a2c1b 100644 --- a/developer/docs/help/context/package-editor.md +++ b/developer/docs/help/context/package-editor.md @@ -129,6 +129,12 @@ are optional. A web site is encouraged and should be filled in the web site field, including the initial "http://" or "https://". +The Description is the keyboard summary that users will see on the keyboard’s +overview page at the keyman.com web site. +[GitHub style Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) +can be used in the description text. However, HTML tags are not supported. + + A package can optionally include a 140x250 JPEG or PNG image file to be shown during installation. This image file must be added to the Files list in step 1, then selected from the list here. @@ -191,4 +197,4 @@ keyboard to the [Keyman Cloud Keyboards Repository](/developer/keyboards/). ## Package Installers As of Keyman Developer 17, bundled executable package installers for Keyman for -Windows can be created using [kmc](kmc), but cannot be created within the IDE. \ No newline at end of file +Windows can be created using [kmc](kmc), but cannot be created within the IDE.