Skip to content

auto: Keyman for developer help deployment #2518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keyman-status merged 1 commit into from
May 21, 2026
Merged

auto: Keyman for developer help deployment #2518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 27 additions & 15 deletions developer/19.0/guides/lexical-models/distribute/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,34 @@ welcome.htm
is also the entry point for help when accessed via Keyman's help
system or Keyman Configuration.

## Step 1) Share the lexical model package file
## Sharing the lexical model through Keyman Cloud

Once the lexical model package .kmp file is created, you can share them
via external storage devices (USB drive, SD card, etc). If that is not
an option, you can upload the .kmp file to a public facing website. For
this example, the lexical model package for SENĆOŦEN is being uploaded:
Follow the [Keyman Cloud Lexical Models Repository guide](/developer/lexical-models) for
instructions on how to make your lexical model available through Keyman Cloud,
where it will become seamlessly available to all users of Keyman.

1. nrc.str.sencoten.model.kmp (the lexical model package .kmp file)
## Sharing the lexical model through other channels

## Step 2) Create a link to the KMP file
Using Keyman Cloud is the recommended and simplest model of distribution, as it
is generally seamless for end users. However, it is also possible to distribute
a lexical model package through other mechanisms:

Once all the files have been uploaded, you will need to provide a link
to the lexical model package .kmp file for your device to download and
install. This can either be a link on a web page, or a link in an email.
In this tutorial, a very simple .html web page with a link to the
nrc.str.sencoten.kmp file is created:
### Step 1) Share the lexical model package file

Once the lexical model package .model.kmp file is created, you can share them
via external storage devices (USB drive, SD card, etc). If that is not an
option, you can upload the .model.kmp file to a public facing website. For this
example, the lexical model package for SENĆOŦEN is being uploaded:

1. nrc.str.sencoten.model.kmp (the lexical model package .model.kmp file)

### Step 2) Create a link to the lexical model KMP file

Once all the files have been uploaded, you will need to provide a link to the
lexical model package .model.kmp file for your device to download and install.
This can either be a link on a web page, or a link in an email. In this
tutorial, a very simple .html web page with a link to the
nrc.str.sencoten.model.kmp file is created:

```html
<html>
Expand All @@ -65,6 +77,6 @@ nrc.str.sencoten.kmp file is created:

The link must be in the format `http://` or `https://`

Upload the web page to your public facing website. Once done, you can
install the lexical model package onto your mobile devices by
downloading the .kmp from your device's internet browser.
Upload the web page to your public facing website. Once done, you can install
the lexical model package onto your mobile devices by downloading the .model.kmp
from your device's internet browser.
2 changes: 1 addition & 1 deletion developer/19.0/guides/lexical-models/distribute/tutorial/step-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ documentation is accessible to the end user.

Once you have tested the package to your satisfaction, it is time to
distribute it. We recommend submitting your lexical model package to the
[Keyman Lexical Models Repository](https://github.com/keymanapp/lexical-models)
[Keyman Lexical Models Repository](/developer/lexical-models)

## Distributing a package on your own website

Expand Down
Loading