https://github.com/tadast/snipcheat

Generate a cheat sheet html file given a directory with Sublime text snippets
https://github.com/tadast/snipcheat

Last synced: 11 days ago
JSON representation

Generate a cheat sheet html file given a directory with Sublime text snippets

• Host: GitHub
• URL: https://github.com/tadast/snipcheat
• Owner: tadast
• License: mit
• Created: 2012-11-28T17:04:56.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2013-03-30T12:14:14.000Z (over 11 years ago)
• Last Synced: 2024-11-29T13:13:56.926Z (24 days ago)
• Language: Ruby
• Homepage:
• Size: 150 KB
• Stars: 22
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Snipcheat

Snipcheat takes a directory with sublime snippets and generates you a cheatsheet file. Take a look at [an example cheatsheet](http://tadast.github.com/sublime-rails-snippets) for [Rails](https://github.com/tadast/sublime-rails-snippets) bundle.

[![Build Status](https://travis-ci.org/tadast/snipcheat.png?branch=master)](https://travis-ci.org/tadast/snipcheat)

[![Code Climate](https://codeclimate.com/github/tadast/snipcheat.png)](https://codeclimate.com/github/tadast/snipcheat)

## Installation

    $ gem install snipcheat

## Usage

    $ snipcheat generate -d Packages/Rails -o ~/rails_cheatsheet.html

## Contributing

Contributions are very welcome. Please consider the list of things that could improve the gem:

* Better/more CSS styles for output

* Live search

* Ability to generate a website with nested lists of cheatsheets

### How to contribute

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request