PaladinTyrion / gowalker

Go Walker is a server that generates Go projects API documentation on the fly.

Home Page:https://gowalker.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Go Walker wercker status

中文文档

Go Walker is a server that generates Go projects API documentation on the fly. It supports BitBucket, GitHub, Google Code, Launchpad, Git @ OSC and GitCafe.

Features

  • Search and view huge amounts documentation of projects.
  • Type package import path or keywords in search boxes to find or create documentation.
  • Generate Go project documentation on the fly .
  • View documentation by tags of projects.
  • One-click Code view for functions and methods code in current package in the same page with nice highlight.
  • Mouse hover tip and jump link for functions, methods and types in current package.
  • Code highlight and jump link for functions, methods and types from imported packages.
  • Control panel for keyboard shortcuts and more function: compatible with godoc.org.
  • Multiple language support for readme(.md): About.
  • Add third-party examples for your favorite projects: through Github Gist.

Credits

  • chenwenli Thanks for adding feature of Control Panel.
  • slene Thanks for README css.
  • atotto Thanks for translating site user interface to Japanese.
  • garyburd Thanks for teaching me about license.
  • Sub-package doc is originally a fork of gosrc.

License

This project is under Apache v2 License. See the LICENSE file for the full license text.

About

Go Walker is a server that generates Go projects API documentation on the fly.

https://gowalker.org

License:Apache License 2.0


Languages

Language:Go 91.5%Language:JavaScript 4.4%Language:CSS 4.0%