https://github.com/jdonaldson/vim-cheat-x-in-y

A plugin for vim that shows a cheat sheet for a given filetype
https://github.com/jdonaldson/vim-cheat-x-in-y

Last synced: about 1 month ago
JSON representation

A plugin for vim that shows a cheat sheet for a given filetype

• Host: GitHub
• URL: https://github.com/jdonaldson/vim-cheat-x-in-y
• Owner: jdonaldson
• Created: 2013-06-01T07:12:15.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2019-10-14T18:44:25.000Z (about 5 years ago)
• Last Synced: 2023-03-11T08:12:59.796Z (almost 2 years ago)
• Language: Vim script
• Size: 11.7 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vim-cheat-x-in-y

![screenshot](http://i.imgur.com/1ZAin3j.png)

This plugin lets you quickly open up a cheat sheet for a given language in a

vertical split on the right.  Specifically, they are the guides from

[learnXinYminutes][].

# Installation

The recommended way to install vim-cheat-x-in-y is using a bundle management system such

as [vim-plug][], [pathogen][], [vundle][], or [vam][]. Check the respective

readmes for specific installation instructions.

The author endorses vim-plug for this project, since it automatically resolves

the submodule dependency for learnXinY. 

Add this to your vimrc or bundle list, and source it:

```viml

Plug 'jdonaldson/vim-cheat-x-in-y'

```

run : 

```viml

:PlugInstall

```

# Usage

The plugin adds a single command:  ```:ToggleCheat```.  This will open or close

a vertical split containing the read-only markdown cheat file for the current

file type.

If a cheat file is not available, a message will be displayed.

# Credit

[learnXinYminutes][], for most

of the guides, and for which this plugin is named.

[learnXinYminutes]:https://github.com/adambard/learnxinyminutes-docs

[vim-plug]:https://github.com/junegunn/vim-plug

[pathogen]:https://github.com/tpope/vim-pathogen

[vundle]:https://github.com/gmarik/vundle

[vam]:https://github.com/MarcWeber/vim-addon-manager