Merge pull request #8 from rtuszik/v0.2.0

v0.2.0
rtuszik · Oct 11, 2024 · f913d5e · f913d5e
2 parents cc427d1 + a8e1dec
commit f913d5e
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 4 deletions.
diff --git 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
+
+<p align="center">
+  <img src="assets/images/KoalaKeys_Example.png">
+</p>
 
 ## 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
diff --git 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
@@ -3,7 +3,11 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <link rel="icon" type="image/x-icon" href="/assets/icons/favicon.ico" />
+    <link
+      rel="icon"
+      type="image/x-icon"
+      href="https://github.com/rtuszik/KoalaKeys/blob/cc427d1ee6fcc8a6f671954848b161c8f1bff599/assets/icons/favicon.ico"
+    />
     <title>{{ title }} Cheatsheet</title>
     <link
       href="https://iosevka-webfonts.github.io/iosevka/Iosevka.css"

diff --git a/src/index_template.html b/src/index_template.html
@@ -3,7 +3,11 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <link rel="icon" type="image/x-icon" href="/assets/icons/favicon.ico" />
+    <link
+      rel="icon"
+      type="image/x-icon"
+      href="https://github.com/rtuszik/KoalaKeys/blob/cc427d1ee6fcc8a6f671954848b161c8f1bff599/assets/icons/favicon.ico"
+    />
     <title>Cheatsheet Index</title>
     <link
       href="https://iosevka-webfonts.github.io/iosevka/Iosevka.css"