Skip to content

seacoastboy/gowalker

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go Walker

中文文档

Go Walker is a web server that generates Go projects API documentation with source code on the fly from projects on Bitbucket, Github, Google Code, Launchpad and Git @ OSC.

Features

  • Search and view huge amounts documentation of projects: over 7000 projects involved.
  • Type package import path or keywords in search boxes to find or create documentation.
  • Generate Go project documentation on the fly : no more installation required for using.
  • View documentation by tags of projects: don't worry for using old version.
  • Code view for functions and methods code in current package in the same page with nice highlight: reduce rake up space and do more work at the same time.
  • Mouse hover tip and jump link for functions, methods and types in current package: reduce time to find.
  • Code highlight and jump link for functions, methods and types from imported packages: reduce time to find.
  • Control panel for keyboard shortcuts and more function: compatible with godoc.org.
  • Use Tag to label your project: list by categories.
  • Multiple language support for readme(.md): About.
  • Add third-party examples for your favorite projects: through Github Gist.
  • Full documentation.

Third-party packages

  • Beego: a lightweight web framework for web application quick development.
  • Qbs: Query by Struct is an excellent ORM, it supports MySQL, SQLite3 and PosgreSQL.
  • go-sqlite3: SQLite3 database driver for Go; it implemented database/sql interface which is a very big deal for code migration; it requires cgo.

Credits

  • chenwenli Thanks for adding feature of Control Panel.
  • atotto Thanks for translating site user interface to Japanese.
  • Source files that contain code that is from gddo is honored in specific.

Todo

  • Add specialized markdown to HTML function for parsing readme in gowalker.

License

Apache License, Version 2.0.

About

Go Walker is a web server that generates Go projects API documentation with source code on the fly.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published