Minor revisions on #244

- When using GFM code fences, strip the last line in addition to the
  first
- Updated `README.md` to mention the new feature
- `minor` version-bump to `2.2.0`.

CHANGELOG

@@ -1,3 +0,0 @@
-Changelog
-=========
-

CONTRIBUTING.md

@@ -3,15 +3,23 @@ Contributing
 If you would like to contribute cheetsheets or program functionality, please
 fork this repository, make your changes, and submit a pull request.
 
+
+## Python standards ##
 Python code should conform to [PEP 8][].
 
-Licensing
----------
-By contributing to the project, you agree to license your work under the same
-licenses as `cheat` itself. `cheat` is currently dual-licensed under the GPL3
-and MIT licenses, though that could change without notice in the future.
 
-`cheat`, however, will always remain free software (as in both "free as in
+## Cheatsheet Format ##
-freedom" and "free as in beer") and shall always be licensed accordingly.
+Please pattern your cheatsheets after the following:
+
+```sh
+# To extract an uncompressed archive:
+tar -xvf /path/to/foo.tar
+
+# To create an uncompressed archive:
+tar -cvf /path/to/foo.tar /path/to/foo/
+
+# To extract a .gz archive:
+tar -xzvf /path/to/foo.tgz
+```
 
 [PEP 8]: http://legacy.python.org/dev/peps/pep-0008/ 

README.md

@@ -1,5 +1,4 @@
 [![PyPI](https://img.shields.io/pypi/v/cheat.svg)](https://pypi.python.org/pypi/cheat/)
-[![PyPI](https://img.shields.io/pypi/dm/cheat.svg)](https://pypi.python.org/pypi/cheat/)
 
 cheat
 =====
@@ -74,7 +73,7 @@ variable set, you may edit cheatsheets with:
 cheat -e foo
 ```
 
-If the 'foo' cheatsheet already exists, it will be opened for editing.
+If the `foo` cheatsheet already exists, it will be opened for editing.
 Otherwise, it will be created automatically.
 
 After you've customized your cheatsheets, I urge you to track `~/.cheat/` along
@@ -110,13 +109,32 @@ export CHEATPATH="$CHEATPATH:/path/to/more/cheats"
 You may view which directories are on your `CHEATPATH` with `cheat -d`.
 
 ### Enabling Syntax Highlighting ###
-`cheat` can apply syntax highlighting to your cheatsheets if so desired. To
+`cheat` can optionally apply syntax highlighting to your cheatsheets. To enable
-enable this feature, set a `CHEATCOLORS` environment variable:
+syntax highlighting, export a `CHEATCOLORS` environment variable:
 
 ```sh
 export CHEATCOLORS=true
 ```
 
+#### Specifying a Syntax Highlighter ####
+You may manually specify which syntax highlighter to use for each cheatsheet by
+wrapping the sheet's contents in a [Github-Flavored Markdown code-fence][gfm].
+
+Example:
+
+<pre>
+```sql
+-- to select a user by ID
+SELECT *
+FROM Users
+WHERE id = 100
+```
+</pre>
+
+If no syntax highlighter is specified, the `bash` highlighter will be used by
+default.
+
+
 See Also:
 ---------
 - [Enabling Command-line Autocompletion][autocompletion]
@@ -125,5 +143,6 @@ See Also:
 
 [autocompletion]:   https://github.com/chrisallenlane/cheat/wiki/Enabling-Command-line-Autocompletion
 [dotfiles]:         http://dotfiles.github.io/
+[gfm]:              https://help.github.com/articles/creating-and-highlighting-code-blocks/
 [installing]:       https://github.com/chrisallenlane/cheat/wiki/Installing
 [related-projects]: https://github.com/chrisallenlane/cheat/wiki/Related-Projects

bin/cheat

@@ -42,7 +42,7 @@ from docopt import docopt
 
 if __name__ == '__main__':
     # parse the command-line options
-    options = docopt(__doc__, version='cheat 2.1.28')
+    options = docopt(__doc__, version='cheat 2.2.0')
 
     # list directories
     if options['--directories']:

cheat/utils.py

@@ -13,14 +13,23 @@ def colorize(sheet_content):
 
     try:
         from pygments import highlight
-        from pygments.lexers import BashLexer
+        from pygments.lexers import get_lexer_by_name
         from pygments.formatters import TerminalFormatter
 
     # if pygments can't load, just return the uncolorized text
     except ImportError:
         return sheet_content
 
-    return highlight(sheet_content, BashLexer(), TerminalFormatter())
+    first_line = sheet_content.splitlines()[0]
+    lexer      = get_lexer_by_name('bash')
+    if first_line.startswith('```'):
+        sheet_content = '\n'.join(sheet_content.split('\n')[1:-2])
+        try:
+            lexer = get_lexer_by_name(first_line[3:])
+        except Exception:
+            pass
+
+    return highlight(sheet_content, lexer, TerminalFormatter())
 
 
 def die(message):

setup.py

@@ -3,7 +3,7 @@ import os
 
 setup(
     name         = 'cheat',
-    version      = '2.1.28',
+    version      = '2.2.0',
     author       = 'Chris Lane',
     author_email = 'chris@chris-allen-lane.com',
     license      = 'GPL3',