Go Walker ======== [中文文档](README_ZH.md) Go Walker is a web server that generates <a target="_blank" href="http://golang.org/">Go</a> projects API documentation and hacker view on the fly for the projects that are hosted on <b><a target="_blank" href="https://bitbucket.org/">Bitbucket</a></b>, <b><a target="_blank" href="https://github.com/">GitHub</a></b>, <b><a target="_blank" href="http://code.google.com/">Google Code</a></b>, <b><a target="_blank" href="https://launchpad.net/">Launchpad</a></b> and <b><a target="_blank" href="http://git.oschina.net/">Git @ OSC</a></b>. ## 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](http://gowalker.org/about). - Add **third-party examples** for your favorite projects: through Github Gist. - Source file based code view. ## Develop route See board on [Trello](https://trello.com/b/wS7CzdcI/go-walker) about to do, bugs and road map. ## Third-party packages - [Beego](http://gowalker.org/github.com/astaxie/beego): a **lightweight** web framework for web application **quick** development. - [Qbs](http://gowalker.org/github.com/coocood/qbs): **Query by Struct** is an excellent ORM, it supports MySQL, SQLite3 and PosgreSQL. - [goconfig](https://github.com/Unknwon/goconfig): a easy-use **comments-support** configuration file(.ini) parser for the Go Programming Language. ## Credits - [chenwenli](http://www.lavachen.cn) Thanks for adding feature of [Control Panel](http://gowalker.org/about#control_panel). - [slene](https://github.com/slene) Thanks for README css. - [atotto](https://github.com/atotto) Thanks for translating site user interface to Japanese. - [garyburd](https://github.com/garyburd) Thanks for teaching me about license. - Sub-package **doc** is originally a fork of [gosrc](https://github.com/garyburd/gosrc). ## License [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).