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/reference/kmc/api/index.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

3.7 KiB
Raw Blame History

title
kmc API Reference

kmc is implemented in Typescript as a set of compiler modules. Each module has a public API, documented in README.md in the corresponding repository folder.

This section is intended for software developers who want to integrate kmc into their own toolchains. For documentation on using kmc, see kmc command line compiler.

Modules

Module Name NPM Package GitHub Source Description
kmc @keymanapp/kmc GitHub The official command-line interface for all of the various compilers in Keyman Developer.
kmc-analyze @keymanapp/kmc-analyze GitHub Provides Keyman keyboard analysis tools.
kmc-keyboard-info @keymanapp/kmc-keyboard-info GitHub Builds a .keyboard_info file from a Keyman keyboard project.
kmc-kmn @keymanapp/kmc-kmn GitHub Builds .kmn keyboards into .kmx binary keyboard files.
kmc-ldml @keymanapp/kmc-ldml GitHub Builds LDML .xml keyboards into Keyman .kmx binary keyboard files.
kmc-model @keymanapp/kmc-model GitHub Builds .model.ts lexical models into .model.js files.
kmc-model-info @keymanapp/kmc-model-info GitHub Builds a .model_info file from a Keyman lexical model project.
kmc-package @keymanapp/kmc-package GitHub Builds .kps Keyman package source files into binary .kmp Keyman package files.