Add docs for keys modification (#1937)

* Add keymaps docs to website

* de-beautify
This commit is contained in:
Philippe Potvin 2017-06-14 21:03:41 -04:00 committed by GitHub
parent 0bf10f3768
commit ab703b5bf2
2 changed files with 24 additions and 2 deletions

View file

@ -116,5 +116,10 @@ module.exports = {
// in development, you can create a directory under
// `~/.hyper_plugins/local/` and include it here
// to load it and avoid it being `npm install`ed
localPlugins: []
localPlugins: [],
keymaps: {
// Example
// 'window:devtools': 'cmd+alt+o',
}
};

View file

@ -678,6 +678,23 @@
<a href="https://github.com/bnb/awesome-hyper">Awesome Hyper</a>
for a curated list of plugins and resources.</p>
<h2 id="keymaps"><a href="#keymaps">Keymaps</a></h2>
<P> All command keys can be changed. In order to change them, edit
<code>~/.hyper.js</code> and add your desired change to <code>keymaps</code>.
</p>
<p> Then Hyper will change the default with your custom change.</p>
<p> Example: <code>'window:devtools': 'Cmd+Alt+O'</code> <p>
<pre><code>module.exports = {
config: { /*... */ },
keymaps: {
'window:devtools': 'cmd+alt+o'
}
};</code></pre>
<h2 id="cfg"><a href="#cfg">Configuration</a></h2>
<p>The <code>config</code> object seen above in <code>~/.hyper.js</code>