diff --git a/README.md b/README.md index 254e5dd..11f081f 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,13 @@ A simple tool to create and manage interactive keyboard shortcut cheatsheets. KoalaKeys helps generate and organize interactive HTML cheatsheets for keyboard shortcuts. It's designed for developers, designers, and power users who want to keep their essential shortcuts easily accessible. -> **Quick Start**: To create a cheatsheet, add a YAML file to the `cheatsheets` directory and run `python src/generate_cheatsheet.py`. For detailed YAML formatting instructions, see the [YAML Cheatsheet Specification Guide](yaml_cheatsheet_specification.md). +> **Quick Start**: To create a cheatsheet, add a YAML file to the `cheatsheets` directory and run `python src/generate_cheatsheet.py`. For detailed YAML formatting instructions, see the [YAML Cheatsheet Specification Guide](https://github.com/rtuszik/KoalaKeys/blob/cc427d1ee6fcc8a6f671954848b161c8f1bff599/yaml_cheatsheet_spec.md). + +## Screenshots + +

+ +

## Features @@ -82,7 +88,7 @@ Explore the demo to see how KoalaKeys works and to get ideas for creating custom ## Usage -1. Create YAML files for your cheatsheets in the `cheatsheets` directory. For detailed instructions on how to format YAML files, please refer to the [YAML Cheatsheet Specification Guide](yaml_cheatsheet_spec.md). +1. Create YAML files for your cheatsheets in the `cheatsheets` directory. For detailed instructions on how to format YAML files, please refer to the [YAML Cheatsheet Specification Guide](https://github.com/rtuszik/KoalaKeys/blob/cc427d1ee6fcc8a6f671954848b161c8f1bff599/yaml_cheatsheet_spec.md). 2. Generate cheatsheets: diff --git a/assets/images/KoalaKeys_Example.png b/assets/images/KoalaKeys_Example.png new file mode 100644 index 0000000..e9f3f73 Binary files /dev/null and b/assets/images/KoalaKeys_Example.png differ diff --git a/requirements.txt b/requirements.txt index 9770eb5..3fddd40 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ pyyaml==6.0.2 jinja2==3.1.4 python-dotenv==1.0.1 +ruamel.yaml==0.18.6 diff --git a/src/cheatsheet_template.html b/src/cheatsheet_template.html index 9b28cbb..dbb0f65 100644 --- a/src/cheatsheet_template.html +++ b/src/cheatsheet_template.html @@ -3,7 +3,11 @@ - + {{ title }} Cheatsheet - + Cheatsheet Index