Create with jQuery a keymap to display keybindings
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
layouts
LICENSE.md
README.md
keymap.css
keymap.jquery.json
keymap.js
keymap.min.css
keymap.min.js
package.json

README.md

#Keymap

Create your own keymap to display the keybinings of your software with jQuery.

##Version 2.0.0

Introducing second and third levels of keyboards to keymap. Allows to display additional information such as {, } or @.

##Installation/Quickstart

  • Download the zip file and unzip it.
  • Include keymap.js and keymap.css
<!--
    Include Keymap
-->
<script src="//code.jquery.com/jquery-1.11.3.min.js"></script>
<script src="keymap.js"></script>
<link href=keymap.css" rel="stylesheet">
  • Initiate the plugin
$(document).ready(function(){
    $.getJSON('layouts/qwerty.json', function(json){
        $('.keymap').keymap({"css": {"key": {"background": "white", "color": "black"}}});
        $('.shortcut').createShortcut('.keymap', ["ctrl", "s"], {}, ":first");
    });
});
  • For more details: Check the wiki

##Examples

Example #####Live preview on Andrano.de

##Contribute You want to contribute a new layout or some fixes create a pull request or send an email to andranode[at]gmail.com