ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Find​Doc

by zckrs ST2/ST3

Find documentation in Sublime Text

Details

  • 2014.09.18.09.18.29
  • github.​com
  • github.​com
  • 5 years ago
  • 12 minutes ago
  • 8 years ago

Installs

  • Total 3K
  • Win 2K
  • OS X 546
  • Linux 374
Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4
Windows 0 0 0 0 0 0 0 2 0 1 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

FindDoc - Sublime Text plugin

This is a Sublime Text plugins that allows you to search the documentation on your favorites urls.

How to install

The easiest way to install this is with Package Control.

Or you can download the zip archive and unzip in your packages directory (by Preferences->Browse Packages…).

How to configure

The default shortcut to call the plugin is : ctrl + alt + d.

The default used url is : http://devdocs.io/#q=%s.

But you can set multiple shortcuts and urls by your key bindings.

Examples :

{ "keys": ["ctrl+alt+d"], "command": "find_doc_selection", "args" : {"url" : "http://devdocs.io/#q=%s"} }
{ "keys": ["ctrl+alt+g"], "command": "find_doc_selection", "args" : {"url" : "http://google.fr/search?q=%s"} }
{ "keys": ["ctrl+alt+k"], "command": "find_doc_selection", "args" : {"url" : "http://php.net/%s"} }

Others examples : you can open cheat sheet or what do you want

{ "keys": ["ctrl+alt+c"], "command": "find_doc_selection", "args" : {"url" : "http://www.cheatography.com/fredv/cheat-sheets/gmail-cheat-sheet/"} }
{ "keys": ["ctrl+alt+n"], "command": "find_doc_selection", "args" : {"url" : "http://www.nyan.cat/"} }

You can also use the same shorcut but do differents action based on the current context:

  • this is the default key binding
{
    "keys": ["ctrl+alt+d"],
    "command": "find_doc_selection",
    "args" : {"url" : "http://devdocs.io/#q=%s"}
}
  • Context-based key binding for Python code…
{
    "keys": ["ctrl+alt+d"],
    "command": "find_doc_selection",
    "args" : {"url" : "http://devdocs.io/#q=python%%20%s"},
    "context": [
        {
            "key":      "selector",
            "operator": "equal",
            "operand":  "source.python"
        }
    ]
}
  • Another one for JavaScript code…
{
    "keys": ["ctrl+alt+d"],
    "command": "find_doc_selection",
    "args" : {"url" : "https://developer.mozilla.org/fr/search?q=%s"},
    "context": [
        {
            "key":      "selector",
            "operator": "equal",
            "operand":  "source.js"
        }
    ]
}

Note: you need to put context-specific key binding after the default

How to use

Highlight the function(s)/method(s)/text(s) to search and use the shortcut to open a new tab(s).

If you don't highlight text, the plugin selects the current word at cursor by camelCase.

How to contribute

If you have some problems or improvements, contact me via GitHub.