Skip to content

hendyyou/gowalker

 
 

Repository files navigation

Go Walker

中文文档

Go Walker is a server that generates Go projects source code documentation on the fly from projects on Bitbucket, Github, Google Project Hosting and Launchpad.

Features

  • Input the package import path or keywords in search boxes in home page to find or create documentation.
  • Generate Go project documentation on the fly : no more installation required for using.
  • Mouse hover tip and jump link for public functions and types in current package: reduce time to find.
  • Code view for public functions, methods in current package in the same page: reduce rake up space and do more work at the same time.
  • Code highlight and jump link for public functions, types from imported packages: reduce time to find.
  • Type-ahead for standard library: not a big deal.
  • Control panel for keyboard shortcuts: compatible with godoc.org.
  • Use Tag to label your project: list by categories.

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.

Acknowledge

Todo

  • Add specialized markdown to HTML function for parsing readme in gowalker.
  • Add user system and compatible for using gopm in the future.
  • Add support for user submit examples.
  • Add support for multi-language documentation.

License

Apache License, Version 2.0, some part of code in this project is from gopkgdoc,see File Change Log for deatil.

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published