What it does?

Translate existing cheatsheets from Cheaters to navigable documentation (docset) file to use with Dash

Now with code fragment highlight thanks to the power of highlight.js and jquery.js and Brett, tinkering on his code I learned all this!.

Now you can subscribe to the feed to get automatic update of the docset here subscribe to cheaters2docset.xml.

Cheatsheet included

All cheatsheets available in Brett's Cheaters

• JSStrings
• alfred
• bashhistory
• emmet
• git-advanced
• git
• gmail
• html5
• index
• javascripts
• jira
• jquery
• keybindings
• markdown
• mmd
• patternsregex
• rst (cheaters pull request #11)
• scapple
• screen
• selectors
• siri
• subl
• subl2
• tmux
• towergithtml (cheaters pull request #10)
• trickster
• vim

A couple experimental* cheatsheets I did:

• PostgreSQL 9.0 Cheatsheet > Markdown version on gist
• PostGIS 2.0 Cheatsheet > Markdown version on gist
• Subversion Cheatsheet by DaveChild> Markdown version on gist

I'm happy to have contribution on cheatsheets translation, markdown preferred, but html is accepted too.

* **experimental**: I don't have time to properly edit this file, so use it as it is. Any help is welcome!

How to to : Short Version

1. clone/download the repository

• add the cheaters2docset.docset
• enjoy it!

How to to : Long Version

Interesting enough, I actually use the cheaters2docset.docset to write this README.md

This release essentially does:

• copy all the html file longer that 10 lines in the .docset ( I assume here that > 10 means actual HTML, not just reference to an image. I might be wrong!)
• add an headed and a footer (stripped fromt the index.html)
• copy the css/ and javascritp/ directory to the .docset
• fill the sqlite DB with cheatseets names.
  • convert the markdown cheatshet in the local cheatsheet/ directory to html
  • fill the sqlite DB with markdown-cheatsheets names.

You can run the cheaters2docset.py script, adapting all the path in the the python script with your Cheaters' cheatsheets path like

cheaters_path = /Users/YOUR_USER/cheaters/cheatsheets

and taking care of all the dependencies:

• multimarkdow (needed to translate markdown files)

• Python modules (needed to move file,parse it and a lot of stuff) :

  • sqlite3
  • glob
  • os
  • subprocess
  • BeautifulSoup (not essential, but I like prettified html code)

I installed everything with macports on a Mac OSX 10.7.5 and on 10.8.2, works fine.