Giter Club home page Giter Club logo

go-explorer's Introduction

Go Explorer

Go Explorer is a Vim plugin for exploring Go code.

Go Explorer is a work in progress. It's usable, but there's much more to do. Use the Go Explorer issue tracker to report bugs and request features.

View the demonstration screencast.

GeDoc

The GeDoc command shows documentation for the package specified by spec.

:GeDoc spec 

If spec starts with '', then spec is take as the name of a package imported in the current file. Otherwise spec is taken as a package import path. The GeDoc command supports command completion.

In the documentation viewer, use <c-]> to jump to source code or documentation. If the identifier under the cursor is the name of a declaration, then <c-]> jumps to the source code for the declaration. If the identifier under the cursor is a type, then <c-]> jumps to the documentation for the type. <C-t> jumps back. Use ]] and [[ to move forward and back through declarations in the documentation.

Documentation pages can be opened directly using the godoc:// prefix:

:edit godoc://net/http

Installation Instructions

To install this plugin with Pathogen, use:

 git clone https://github.com/garyburd/go-explorer.git ~/.vim/bundle/go-explorer

The plugin requires a Go helper program:

 go get github.com/garyburd/go-explorer/src/getool

The plugin and the getool program are tightly coupled. Update both at the same time.

Other plugins

Go Explorer is compatible with vim-go.

go-explorer's People

Contributors

garyburd avatar akavel avatar

Watchers

Kevin Hatfield avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.