Need help with sublime-text-2-goto-documentation?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

127 Stars 36 Forks 53 Commits 12 Opened issues


Sublime Text 2 plugin to go to documentation

Services available


Need anything else?

Contributors list


A Sublime Text plugin to jump to documentation for the current keyword.


  • PHP
  • JS / CoffeeScript
  • HTML
  • Python (via
  • Clojure
  • Go
  • Ruby (+Rails)
  • C / C++
  • Perl
  • C#
  • Lua
  • Postgres
  • Erlang
  • Smarty
  • Haskell
  • can add any other language via settings


Via Package Control
Search for


Clone this project in your Packages folder under the name

git clone GotoDocumentation

How to use

Move the cursor inside the word you want the docs for and: * Press

* Open command palette (Ctrl+Shift+P) and search for for GotoDocumentation

Edit the urls

GotoDocumentation allows you to edit the url that opens by editing the settings.

The available settings are:

    "prefix": "", // added at the begging of the query
    "suffix": "", // added at the end of the query
    "docs": { // obj containing the docs for each scope
              // these are merged with the default ones

    // the key value pair represent scope -> doc url
    // supported placeholders:
    //  - %(query)s the selected text/word
    //  - %(scope)s the current scope
   "css": "",

    // we can also have an object to
    // run a command for finding docs
    // inside the command you can use the same placeholders
    "python": {
        // the command to be executed
        "command": ["python", "-m", "pydoc", "%(query)s"],
        // a regex to determine if this was an invalid response from the console
        "failTest": ".*no Python documentation found for.*",
        // regex to select something from the valid response
        "changeMatch": "(Related help topics)",
        // regex to replace the matched result
        "changeWith": "-------\n\\1",
        // fallback url: if failTest returns true this will be used
        "url": ""
// if we have no docs for the current scope
// we will try using the fallback one,
// to disable set to false
"fallback_scope": "google"


The change replace is done with the


How to get the scope

To get the scope for a specific place open your sublime console with

ctrl + `
and paste in this command

You can then use that scope to set a rule in the


Submit a patch adding more and I'll include it.

If you find a bug or have suggestions open an issue here

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.