<commit_before>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 with source code on the fly from projects 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>.

![](https://github.com/Unknwon/gowalker/blob/master/docs/images/whatisthis.png?raw=true)

## 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](http://gowalker.org/about).
- Add **third-party examples** for your favorite projects: through Github Gist.
- [Full documentation](https://github.com/Unknwon/gowalker/blob/master/docs/Features.md).

## 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.
- [go-sqlite3](http://gowalker.org/github.com/mattn/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](http://www.lavachen.cn) Thanks for adding feature of [Control Panel](http://gowalker.org/about#control_panel).
- [atotto](https://github.com/atotto) Thanks for translating site user interface to Japanese.
- Source files that contain code that is from [gddo](https://github.com/garyburd/gddo) is honored in specific.

## Todo

- Admin dashboard.
- Update to Beego 1.0.
- Change database to MySQL.
- Function search.
- Use AJAX to load function source code instead reader with documentation at once.

## License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).<commit_msg>Removed Todo section form readme<commit_after>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 with source code on the fly from projects 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>.

![](https://github.com/Unknwon/gowalker/blob/master/docs/images/whatisthis.png?raw=true)

## 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](http://gowalker.org/about).
- Add **third-party examples** for your favorite projects: through Github Gist.
- [Full documentation](https://github.com/Unknwon/gowalker/blob/master/docs/Features.md).

## 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.
- [go-sqlite3](http://gowalker.org/github.com/mattn/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](http://www.lavachen.cn) Thanks for adding feature of [Control Panel](http://gowalker.org/about#control_panel).
- [atotto](https://github.com/atotto) Thanks for translating site user interface to Japanese.
- Source files that contain code that is from [gddo](https://github.com/garyburd/gddo) is honored in specific.

## License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
{'fraction_non_alphanumeric': 0.15103173226981098, 'fraction_numerical': 0.00450840991850182, 'mean_word_length': 4.791164658634538, 'pattern_counts': {'":': 0, '<': 47, '<?xml version=': 0, '>': 47, 'https://': 14, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5030610', 'n_tokens_mistral': 1740, 'n_tokens_neox': 1681, 'n_words': 595}