{"id":18757108,"url":"https://github.com/rtuszik/koalakeys","last_synced_at":"2025-10-09T06:37:06.758Z","repository":{"id":261307364,"uuid":"862641633","full_name":"rtuszik/KoalaKeys","owner":"rtuszik","description":"A tool to create and manage interactive keyboard shortcut cheatsheets.","archived":false,"fork":false,"pushed_at":"2025-08-25T05:51:13.000Z","size":1043,"stargazers_count":92,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-09T23:01:01.576Z","etag":null,"topics":["cheatsheet","cheatsheet-generator","hotkeys","keyboard","keyboard-layout","keyboard-shortcuts","shortcut","shortcut-key","shortcut-learning","shortcuts"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rtuszik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-25T00:12:46.000Z","updated_at":"2025-09-05T14:40:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"65763b33-c948-4d72-85dc-03b71e0e4124","html_url":"https://github.com/rtuszik/KoalaKeys","commit_stats":null,"previous_names":["rtuszik/koalakeys"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/rtuszik/KoalaKeys","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtuszik%2FKoalaKeys","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtuszik%2FKoalaKeys/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtuszik%2FKoalaKeys/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtuszik%2FKoalaKeys/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rtuszik","download_url":"https://codeload.github.com/rtuszik/KoalaKeys/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rtuszik%2FKoalaKeys/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000835,"owners_count":26082951,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cheatsheet","cheatsheet-generator","hotkeys","keyboard","keyboard-layout","keyboard-shortcuts","shortcut","shortcut-key","shortcut-learning","shortcuts"],"created_at":"2024-11-07T17:41:23.175Z","updated_at":"2025-10-09T06:37:06.743Z","avatar_url":"https://github.com/rtuszik.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/icons/KoalaKeys.png\" width=\"256\"\u003e\n\u003c/p\u003e\n\n# KoalaKeys\n\nA simple tool to create and manage portable keyboard shortcut cheat sheets.\n\n\u003e **Demo**: Check out the [live demo](https://rtuszik.github.io/KoalaKeys-Collection/) to see a small collection of cheat sheets created with this project.\n\n## Overview\n\nKoalaKeys generates and organizes portable, interactive HTML cheat sheets for keyboard shortcuts. It's designed for developers, designers, and power users who want to keep their essential shortcuts easily accessible.\n\n\u003e **Quick Start**: To create a cheat sheet, add a YAML file to the `cheatsheets` directory and run `python src/generate_cheatsheet.py`. For detailed YAML formatting instructions, see the [YAML Cheat Sheet Specification Guide](yaml_cheatsheet_spec.md).\n\n## Screenshots\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/images/KoalaKeys_Example.png\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Generate HTML cheat sheets from YAML files\n- Interactive keyboard layout with real-time highlighting\n- Categorized shortcuts with descriptions\n- Index page for quick access to all cheat sheets\n- Search functionality\n- Support for different keyboard layouts and system mappings\n\n## Demo and Examples\n\nA live demo instance is available, showcasing a selection of cheat sheets:\n\n- **Demo Site**: [https://rtuszik.github.io/KoalaKeys-Collection/](https://rtuszik.github.io/KoalaKeys-Collection/)\n- **Demo Repository**: [https://github.com/rtuszik/KoalaKeys-Collection](https://github.com/rtuszik/KoalaKeys-Collection)\n\nExplore the demo to see how KoalaKeys works and to get ideas for creating custom cheat sheets. The demo repository also contains example YAML files that can be used as templates for new cheat sheets.\n\n## Available Systems and Keyboards\n\n### Systems\n\n- Darwin (macOS)\n- Linux\n- Windows\n\n### Keyboard Layouts\n\n- US\n- UK\n- DE (German)\n- FR (French)\n- ES (Spanish)\n- DVORAK\n\n## Requirements\n\n- Python 3.8+\n\n## Installation\n\n1. Clone the repository:\n\n   ```\n   git clone https://github.com/rtuszik/KoalaKeys\n   cd KoalaKeys\n   ```\n\n2. Create and activate a virtual environment (optional):\n\n   ```\n   python -m venv .venv\n   source .venv/bin/activate  # On Windows, use `venv\\Scripts\\activate`\n   ```\n\n3. Install dependencies:\n\n   ```\n   pip install -r requirements.txt\n   ```\n\n4. Set up the output directory:\n   Create a `.env` file in the project root with:\n   ```\n   CHEATSHEET_OUTPUT_DIR=path/to/your/output/directory\n   ```\n\n## Usage\n\n1. Create YAML files for your cheat sheets in the `cheatsheets` directory. For detailed instructions on how to format YAML files, please refer to the [YAML Cheat Sheet Specification Guide](yaml_cheatsheet_spec.md).\n\n2. Generate cheat sheets:\n\n   ```\n   python src/generate_cheatsheet.py\n   ```\n\n3. Find the HTML cheat sheets in the specified output directory.\n\n4. Open `index.html` to view the cheat sheet collection.\n\n## Contributing\n\nContributions are welcome! Feel free to submit issues, feature requests, or pull requests.\n\n## License\n\nThis project is licensed under the terms of the [GPLv3](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtuszik%2Fkoalakeys","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frtuszik%2Fkoalakeys","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frtuszik%2Fkoalakeys/lists"}