https://github.com/ivanmathy/keymages

Key images to represent shortcuts in your GitHub documentation
https://github.com/ivanmathy/keymages

design documentation github

Last synced: 26 days ago
JSON representation

Key images to represent shortcuts in your GitHub documentation

• Host: GitHub
• URL: https://github.com/ivanmathy/keymages
• Owner: IvanMathy
• License: mit
• Created: 2022-09-20T22:01:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-27T02:05:03.000Z (over 2 years ago)
• Last Synced: 2025-03-29T19:23:00.566Z (about 2 months ago)
• Topics: design, documentation, github
• Language: TypeScript
• Homepage:
• Size: 4.08 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![K](./out/mac/dark/large/K.svg) ![E](./out/mac/dark/large/E.svg) ![Y](./out/mac/dark/large/Y.svg) ![M](./out/mac/dark/large/M.svg) ![A](./out/mac/dark/large/A.svg) ![G](./out/mac/dark/large/G.svg) ![E](./out/mac/dark/large/E.svg) ![S](./out/mac/dark/large/S.svg)

A collection of pretty keyboard shortcut images with light/dark Github color schemes, three sizes, and support for Mac and Windows.

## ![Windows](./out/windows/dark/large/windows.svg)

The Windows design is based on the Surface 3 keyboard. However, the typeface is slightly different as I was not able to source a matching version of Segoe (see `I` and `Q`, for example).

![A](./out/windows/dark/medium/A.svg) ![B](./out/windows/dark/medium/B.svg) ![Q](./out/windows/dark/medium/Q.svg) ![B](./out/windows/dark/medium/Ctrl.svg) ![B](./out/windows/dark/medium/Shift.svg) ![B](./out/windows/dark/medium/Alt.svg)

Only a subset of keys are supported, feel free to open a PR or an issue to request/add more.

## ![Apple](./out/mac/dark/large/apple.svg)  

The Mac design is a mix of the latest MacBook Pro, and the legacy Apple USB Keyboard. It has support for standard shortcut icons.

![A](./out/mac/dark/medium/A.svg) ![B](./out/mac/dark/medium/B.svg) ![Q](./out/mac/dark/medium/Q.svg)  ![B](./out/mac/dark/medium/command-glyph.svg) ![B](./out/mac/dark/medium/shift-glyph.svg)![B](./out/mac/dark/medium/option-glyph.svg)

It also has alternative, text-based versions of the same shortcuts.

![B](./out/mac/dark/medium/command.svg) ![B](./out/mac/dark/medium/shift.svg) ![B](./out/mac/dark/medium/option.svg)