Giter VIP home page Giter VIP logo

godocdash's Introduction

Godocdash

Generate Dash docset for Dash/Zeal from your local $GOPATH packages.

Features

  • Support Package, Type, Function, Constant, Variable entry types of dash docsets currently.

  • You can set your own custom docset name and icon for different $GOPATH.

  • Concurrent generating, usally it only takes a few seconds to complete.

  • Go standard libraries are ignored, as there's Go docset in Dash/Zeal downloads already.

How It Works

While running, godocdash will first start a temporary godoc server, then find the package entries to grab the godoc pages, and generate the docset.

Installing

go get -u github.com/wuudjac/godocdash

And make sure godoc command is in your $PATH.

Note: From go 1.13, godoc command has been removed from native distribution, you may need to manually install it.

Usage

Generally, just run:

godocdash

And a docset named GoDoc.docset will be generated in your current directory, you can then place it into Dash/Zeal docsets path.

As godocdash directly passes your current environment variables to godoc, you can change the source $GOPATH by setting it while running godocdash:

GOPATH=/another/gopath godocdash

You can also change the docset name and icon, or mute the output:

GOPATH=/another/gopath godocdash -icon 'new_icon.png' -name 'different name' -silent

Command line flags:

$ godocdash -h
Usage of godocdash:
  -icon string
    	Docset icon .png path
  -name string
    	Set docset name (default "GoDoc")
  -silent
    	Silent mode (only print error)

godocdash's People

Contributors

wuudjac 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.