spiegel-keyman/developer/docs/help/reference/api/kmc-keyboard-info.keyboardinfosources.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

1.4 KiB

Home > @keymanapp/kmc-keyboard-info > KeyboardInfoSources

KeyboardInfoSources interface

Description of sources and metadata required to build a .keyboard_info file

Signature:

export interface KeyboardInfoSources 

Properties

Property Modifiers Type Description
forPublishing boolean Return an error if project does not meet requirements of keyboards repository
jsFilename? string (Optional) The compiled keyboard filename and relative path (.js only)
kmpFilename string The compiled package filename and relative path (.kmp)
kpsFilename string The source package filename and relative path (.kps)
lastCommitDate? string (Optional) Last modification date for files in the project folder 'YYYY-MM-DDThh:mm:ssZ'
sourcePath string The path in the keymanapp/keyboards repo where this keyboard may be found