Skip to content

trailjeep/kbd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Keyboard Shortcut Cheat Sheets

Personal Keyboard Shortcuts repository for use with cheat.sh standalone install.

Install

  1. Install chubin/cheat.sh standalone
  2. Copy kbd.py to $HOME/.cheat.sh/lib/adapter/
  3. Add to $HOME/.cheat.sh/lib/config.py
...
_CONFIG = {
    "adapters.active": [
        "tldr",
        "kbd",
...
    "routing.main": [
        ("", "cheat.sheets"),
        ("", "cheat"),
        ("", "tldr"),
        ("", "kbd"),
...
  1. Initialize:
$HOME/.cheat.sh/ve/bin/python $HOME/.cheat.sh/lib/fetch.py fetch-all

Update

  1. Perform after any repo updates:
$HOME/.cheat.sh/ve/bin/python $HOME/.cheat.sh/lib/fetch.py update-all

Usage

All cheatsheets for app including keyboard:

cht.sh {APP}

Only keyboard cheat sheet for app:

cht.sh kbd:{APP}

Aliases / Functions

if $(command -v cht.sh >/dev/null 2>&1); then
    alias cht='cht.sh'
    kbd() {
        cht.sh kbd:"$1"
    }
    alias kbdl='find $HOME/.cheat.sh/upstream/keyboard/ -name "*.md" -printf "%f\n" | sed "s/.md//" | grep -v README'
fi

Organization

Mostly follows: tldr-pages/tldr

└── pages
    ├── custom     (custom/redefined app shortcuts go here)
        └── APP1.md
    ├── common     (os agnostic app shortcuts go here)
        ├── APP2.md
        └── APP3.md
    ├── linux      (linux app shortcuts go here)
    ├── osx        (osx app shortcuts go here)
    ├── sunos      (sunos app shortcuts go here)
    ├── windows    (windows app shortcuts go here)
    └── android    (android app shortcuts go here - probably unused)

Template

Mostly follows: tldr-pages/tldr

Note: ☐☐ represents 2 spaces for GitHub newline.

# APP_NAME

> DESCRIPTION☐☐
> More information: <URL>.

## Optional Section
|Shortcut|Description|
|:--|:--|
|<kbd>KEY1</kbd>|FUNCTION|
|<kbd>SHIFT</kbd>+<kbd>ALT</kbd>+<kbd>KEY2</kbd>|FUNCTION|
|<kbd>1</kbd> - <kbd>9</kbd>|Range of functions (skip to chapter 1-9)
|<kbd>SPACE</kbd>, <kbd>K</kbd>|Toggle play/pause (separate keys/same function)|

## Optional Section
|Shortcut|Description|
|:--|:--|
|<kbd>KEY3</kbd>|FUNCTION|
|<kbd>SHIFT</kbd>+<kbd>ALT</kbd>+<kbd>KEY4</kbd>|FUNCTION|
|<kbd>CTRL</kbd>+<kbd>RIGHT</kbd> / <kbd>CTRL</kbd>+<kbd>LEFT</kbd>|Previous/Next chapter (consolidate when possible)|

APP_NAME

DESCRIPTION
More information: .

Optional Section

Shortcut Description
KEY1 FUNCTION
SHIFT+ALT+KEY2 FUNCTION
1-9 Range of functions (skip to chapter 1-9)
SPACE, K Toggle play/pause (separate keys/same function)

Optional Section

Shortcut Description
KEY3 FUNCTION
SHIFT+ALT+KEY4 FUNCTION
CTRL+RIGHT / CTRL+LEFT Previous/Next chapter (consolidate when possible)

Acknowledgments

Releases

No releases published

Packages

No packages published

Languages