Development

Documentation sources

Many of the pages on this site are deployed from other repositories and should be edited in the source repository rather than here:

• From https://github.com/keymanapp/keyboards:
  • /keyboard
• From https://github.com/keymanapp/keyman (see resources/build/help-keyman-com.sh):
  • /products/android/
  • /products/iphone-and-ipad/
  • /products/linux/
  • /products/mac/
  • /products/windows/
  • /developer/(.)/ (versioned folders)
  • /developer/engine/android/
  • /developer/engine/iphone-and-ipad/
  • /developer/engine/web/
  • /developer/engine/windows/
  • /developer/core/

How to run help.keyman.com locally with Apache on Docker

Previously, the site was run in IIS, but is now migrated to Apache. The Docker image is configured to host the site that can be accessed at http://localhost:8055.

If you have website-local-proxy running, the help site is available at http://help.keyman.com.localhost.

Pre-requisites

All host machines

The host machine needs the following:

• Git
• Bash (on Windows, you can use Git Bash that comes with Git)
• Docker Desktop

Additional steps

On Windows host machines, do one of these two options:

• Enable Hyper-V on Windows 11
• WSL2

Builder actions

Stop the Docker container

1. Run ./build.sh stop

Build the Docker image

1. Run ./build.sh build.

Start the Docker container

1. Run ./build.sh start --debug.

After this, you can access the help.keyman site at http://localhost:8055

Remove the Docker container and image

1. Run ./build.sh clean.

Running tests

Checks for broken links

1. Run ./build.sh test