diff --git a/docs/index.md b/docs/index.md index 0e9ac71..a25eec1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,6 +8,8 @@ hide: ![KLOR_KMK_LOGO](./images/klor_kmk.svg){ width="400"} +A comprehensive guide of my KMK firmware[^1] for the KLOR keyboard[^2]. + ## Installation Follow these steps: @@ -32,4 +34,5 @@ from kmk.quickpin.pro_micro.sparkfun_promicro_rp2040 import pinout as pins ### [Hide device storage by default](./hide_device_storage.md) - +[^1]: [KMK](https://github.com/KMKfw/kmk_firmware) is a feature-rich and beginner-friendly firmware for computer keyboards written and configured in [CircuitPython](https://circuitpython.org/) +[^2]: An open source keyboard designed by [GEIST](https://github.com/GEIGEIGEIST) diff --git a/docs/rgb.md b/docs/rgb.md index a1a46c9..dd58f94 100644 --- a/docs/rgb.md +++ b/docs/rgb.md @@ -82,7 +82,7 @@ rgb_data = [ You **can't** adjust colors at runtime with `peg_rgb` via keycodes. ## Add RGB keycodes to your keymap -Add some keycodes to your keymap in order to control your RGB lighting e.g.: turn it on or off via `KC.RGB_TOG` +Add some keycodes to your keymap in order to control your RGB lighting e.g.: turn it on or off via ++rgbtog++ === "Basic RGB" Use [these keycodes](https://github.com/KMKfw/kmk_firmware/blob/master/docs/en/rgb.md#keycodes). diff --git a/mkdocs.yml b/mkdocs.yml index d09097d..f613aca 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,3 @@ - site_url: https://moritz-john.github.io/kmk-config-klor/ repo_url: https://github.com/moritz-john/kmk-config-klor @@ -14,8 +13,8 @@ theme: name: material palette: scheme: slate - primary: blue grey - accent: deep orange + primary: black + accent: green logo: assets/logo.svg icon: repo: fontawesome/brands/github @@ -27,26 +26,34 @@ theme: - navigation.footer markdown_extensions: -# align images, add captions to images + # Images: - attr_list - md_in_html -# syntax highlighting + # Code: - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.snippets -# content tabs - pymdownx.superfences + # Content tabs - pymdownx.tabbed: - alternate_style: true -# admonitions + alternate_style: true + # Admonitions: - admonition - pymdownx.details -# lists + # Tables: + - tables + # Footnoes: + - footnotes + # Lists - def_list - -extra_css: - - stylesheets/extra.css + # Keys: + - pymdownx.keys: + key_map: { + "rgbtog": "KC.RGB_TOG", + } +# extra_css: +# - stylesheets/extra.css plugins: - social @@ -56,4 +63,6 @@ extra: - icon: fontawesome/brands/github link: https://github.com/moritz-john/kmk-config-klor +copyright: Created and maintained by Moritz John +