erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13
spiegel-keyman/developer/docs/help/guides/lexical-models/distribute/tutorial/step-1.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

541 B
Raw Blame History

title: Step 1: What do we include?

What is the purpose of a lexical model package? To make installation of a lexical model as straightforward as possible for the end user. We need to keep this goal in mind as we work on all the aspects of a package.

A great package will:

  1. Include one lexical model to install.
  2. Include a 'readme.htm' file which describes why the user would install this package.
  3. Include a 'welcome.htm' file which is displayed before/after install.

Step 2: Editing .htm files for the package