Skip to content

Releases: rtuszik/KoalaKeys

v0.6.0

03 Nov 13:34

Choose a tag to compare

Key Highlights

  • Added support for multi-step key combinations (separate keypress actions), enabling documentation
    of complex shortcuts that require sequential key presses. Thanks @fpuga #42

  • Introduced JSON schema (docs/schema/cheatsheet.schema.json) for cheatsheet validation,
    providing validation support for YAML files.

  • Migrated from requirements.txt to pyproject.toml with uv for faster, more reliable dependency
    management. See README for updated installation instructions.

What's Changed

  • Modularize index template and add project setup by @rtuszik in #32
  • feat: Add support for multi-sequence keyboard shortcuts with animated highlighting by @fpuga in #42
  • chore(deps): bump ty from 0.0.1a22 to 0.0.1a25 by @dependabot[bot] in #46
  • chore(deps): bump ruff from 0.14.0 to 0.14.3 by @dependabot[bot] in #43
  • chore(deps): bump python-dotenv from 1.1.1 to 1.2.1 by @dependabot[bot] in #45

Full Changelog: v0.5.0...v0.6.0

v0.5.0

08 Nov 23:45
073a4a9

Choose a tag to compare

What's Changed

  • fix(docs): fix favicon link to point to raw file by @rtuszik in #17
  • refactor to template components by @rtuszik in #21
  • streamline yaml, improve logging, improve code documentation by @rtuszik in #23 -> closes #22
  • v0.5.0 by @rtuszik in #24

Full Changelog: 0.4.1...v0.5.0

0.4.1

28 Oct 01:47
170de28

Choose a tag to compare

What's Changed

  • v0.4.1 - edit README, repo cleanup, small layout fix by @rtuszik in #16

v0.4.0

28 Oct 00:45
f1a15f7

Choose a tag to compare

What's new?

This release introduces the optional RenderKeys AllowText options to the YAML cheats sheets.

  • RenderKeys (true/false): Disables rendering of the keyboard visual - default: true
  • AllowText (true/false): Allows the shortcut key field to contain arbitrary text - default: false

These options allow the user to create cheat sheets that contain text instead of shortcuts, as well as create more compact cheat sheets. You can find an example of a non-shortcut cheat sheet on the demo instance: Python Built-in Functions and Methods

The AllowText option can only be set to true if RenderKeys is set to false.

Backwards compatibility is maintained, as these flags are optional.


All changes:

  • add RenderKeys and AllowText options
  • add DVORAK
  • update example cheat sheet
  • small cheat sheet layout improvements
  • small bugfixes

Full Changelog: v0.3.0...v0.4.0

v0.3.0

25 Oct 22:36

Choose a tag to compare

What's Changed

#14
UI Changes:

  • Add special styling for modifier keys (⌘, ⌥, ⌃, ⇧)

  • Improve modifier symbol visibility with larger font size

  • Handle escaped plus signs in shortcuts correctly


  • Move templates to dedicated /templates directory

  • Relocate keyboard configs to /layouts directory

  • Extract logging logic to separate logger.py module

  • Consolidate environment setup with clear base paths

  • Remove redundant command line argument parsing

Full Changelog: v0.2.2...v0.3.0

v0.2.2

25 Oct 18:59
86327c9

Choose a tag to compare

What's Changed

Full Changelog: v0.2.1...v0.2.2

v0.2.1

11 Oct 20:21
415e04a

Choose a tag to compare

What's Changed

Full Changelog: v0.2.0...v0.2.1

v0.2.0

11 Oct 14:45
f913d5e

Choose a tag to compare

What's Changed

  • docs(README.md): update and simplify instructions for clarity and con… by @rtuszik in #3
  • chore(deps): bump python-dotenv from 0.19.2 to 1.0.1 by @dependabot in #4
  • feat(README.md): rebrand project from Easy Cheatsheets to KoalaKeys by @rtuszik in #7
  • v0.2.0 by @rtuszik in #8

Full Changelog: v0.1.1...v0.2.0

v0.1.0

28 Sep 16:06
55b00b7

Choose a tag to compare

This marks the initial release of Easy cheat sheets, a tool for creating interactive keyboard shortcut cheat sheets.

What's Included

  • Basic functionality to generate HTML cheat sheets from YAML files
  • Support for multiple operating systems and keyboard layouts
  • Interactive features including search and dark mode

For full details on features and usage, please refer to the README.