https://github.com/gunn/everythingdoc-tmbundle

A textmate bundle to display documentation for the current word. Can override with custom URLs.
https://github.com/gunn/everythingdoc-tmbundle

Last synced: about 2 months ago
JSON representation

A textmate bundle to display documentation for the current word. Can override with custom URLs.

• Host: GitHub
• URL: https://github.com/gunn/everythingdoc-tmbundle
• Owner: gunn
• Created: 2009-06-04T07:54:54.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2009-06-04T10:08:41.000Z (over 15 years ago)
• Last Synced: 2023-04-18T04:19:41.775Z (almost 2 years ago)
• Language: Ruby
• Homepage:
• Size: 78.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.textile

Awesome Lists containing this project

README

        
h1. Overview

A superior textmate documentation bundle (compared to my railsapi-tmbundle)


Picks a source of HTML documentation based on your current textmate scope, and displays it in textmate, or in your browser.

Can be customised with offline and online sources.

Press control-shift-command-h to trigger.

h2. Install with Git:


mkdir -p ~/Library/Application\ Support/TextMate/Bundles

cd ~/Library/Application\ Support/TextMate/Bundles

git clone git://github.com/gunn/EverythingDoc-tmbundle.git "EverythingDoc.tmbundle"

osascript -e 'tell app "TextMate" to reload bundles'



Pressing control-shift-command-h within a ruby document will now bring up a railsapi page for the current word.

Most documents will fetch documentation from gotoapi.com

h2. Customise:

You can override the source to use for documentation.

railsapi.com will let you download docs you can use with EverythingDoc:


Download desired package from http://railsapi.com/

Add a new shell variable from textmate's preferences - RAILS_API_LOCATION,

set its value to the index page. e.g. - /Users/Me/docs/rapi/index.html?q=***



Instant rails documentation from textmate!




To search google for java documentation you would set

JAVA_DOC_LOCATION to http://google.com/search?q=***


Note the stars, these will be replaced with the search term (i.e. your current word).




If you would rather have the documentation page launched in a browser window, you can set *OPEN_DOCS_IN_BROWSER* to *true*

h2. Help:

Do you know of any good documentation sources that could work with this bundle? Let me know! railsapi.com, and gotoapi.com are the only ones I've found.

Have a look at the code:

All the interesting stuff is in - "Support/find_documentation.rb":http://github.com/gunn/EverythingDoc-tmbundle/tree/master/Support/find_documentation.rb