cheatsheet:toggle
in the Atom command palette or press ctrl-alt-#
cheatsheet:edit
in the Atom command palettecheatsheet:reload
in the Atom command paletteAll commands are also available via context menu --> Click the right mouse button on the visible CheatSheet panel
CheatSheet stores all configuration parameters in a config file (support for ".coffee" files only).
OPTIONAL
You have the possibility to set a custom config file path:
cheatsheet:edit
in the Atom command palette -->
this will create a copy of the default CheatSheet file in your custom directoryEdit Config
in the notification dialog -->
this will open your custom CheatSheet
cheatsheet:reload
in the Atom command palette to reload your config file and check if the change was saved successfullyCheatSheet has five type
s you can configure:
header
, subheader
, content
and spacer
header
creates a header
Example:
{type: 'header'text: 'Git'icon: 'devicons devicons-git'}
text
: Add your custom header texticon
OPTIONAL
: Add a custom icon from the Devicon (devicon
) icon-set;
Using the full CSS class is mandatory: devicons devicons-ICONNAME
subheader
creates a subheader
Example:
{type: 'subheader'text: 'Make Changes'}
text
: Add your custom header text
content
creates the copy to clipboard element
Example:
{type: "content"text: 'git add .'description: "Add all files to commit"rows: 5}
text
: Add your custom CheatSheet content. IMPORTANT
: If you are working under windows remember to use \\
to escape \
to show paths correctly:
text: 'venv\\Scripts\\activate'
description
OPTIONAL
: Add a description for more details
rows
OPTIONAL
: Number of rows define the height of the copy area to avoid scrolling
spacer
adds separators between CheatSheet elements
#http://vorillaz.github.io/devicons/#/cheatmodule.exports = [{type: 'header'text: 'Git'icon: 'devicons devicons-git'}{type: 'content'text: 'git init'description: 'Initialize current directory as a repository'}{type: 'content'text: 'git add .'description: 'Add all files to commit'}{type: 'content'text: 'git status'description: 'Displays paths that have differences between the index file and the current HEAD commit'}{type: 'content'text: 'git commit -m [COMITT_NAME]'description: 'Records file snapshots permanently in version history'}{type: 'content'text: 'git push origin master'description: 'Push origin to master'}{type: 'header'text: 'Python Virtual Env'icon: 'devicons devicons-python'}{type: 'subheader'text: 'Create and Activate'}{type: 'content'text: 'python -m virtualenv venv'description: 'Create a new virtual enviroment'}{type: 'content'text: 'venv\\Scripts\\activate'description: 'Activate a virtual enviroment on Windwos'}{type: 'content'text: 'source venv/bin/activate'description: 'Activate a virtual enviroment on Unix/MacOS'}{type: 'subheader'text: 'Requirements'}{type: 'content'text: 'pip freeze > python-requirements.txt'description: 'Create a requirements.txt file'}{type: 'content'text: 'pip install -r requirements.txt'description: 'Install packages from requirements.txt'}{type: 'spacer'}{type: 'header'text: 'HTML'icon: 'devicons devicons-html5'}{type: 'content'text: '<!DOCTYPE html><html><head><title>Page Title</title></head><body><h1>This is a Heading</h1><p>This is a paragraph.</p></body></html>'description: 'Basic HTML file structure'rows: 5}{type: 'header'text: 'Atom'icon: 'devicons devicons-atom'}{type: 'content'text: 'styleguide:show'description: 'Show styleguide for atom'}{type: 'content'text: 'window:toggle-dev-tools'description: 'Toggle dev tools for atom'}]
MIT © Fabian Arlt
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.