|
1 | | -# gohub.github.io |
| 1 | +# GoHub |
| 2 | + |
| 3 | +*GoHub 还在开发中, 一些细节尚未实现* |
| 4 | + |
| 5 | +[GoHub][] 基于 [Github Pages][] 提供在线 Golang 文档阅读. 支持: |
| 6 | + |
| 7 | + - Go Doc API 翻译双语对照 |
| 8 | + - 展示项目 readme |
| 9 | + - 展示第三方项目 |
| 10 | + |
| 11 | +## 开始 |
| 12 | + |
| 13 | +点击顶部 "repos". |
| 14 | + |
| 15 | +## 参与 |
| 16 | + |
| 17 | +GoLang 标准库的翻译文档来自 [Golang-China][] 的 [golangdoc.translations][] 项目. |
| 18 | +GoHub 使用该项目组制定的翻译文档格式. 期待您参与到该项目并丰富翻译文档. |
| 19 | + |
| 20 | +对 GoHub 有任何建议或问题, 请至 GoHub [Wiki][] 和 [Issues][] |
| 21 | + |
| 22 | +## 实现 |
| 23 | + |
| 24 | +得益于 [GitHub API] 和 [RawGit], GoHub 项目代码和 Golang 翻译文档项目代码是分离的. |
| 25 | +GoHub 通过 GitHub API 获取项目的 Latest release Tag, 从 RawGit CDN 获取该 Tag 下的文档. |
| 26 | +RawGit CDN 中的数据是静态的, 不提供更新服务. 更新 Latest release Tag 可使 GoHub 展现新的文档. |
| 27 | +对于没有建立 Latest release Tag 的项目, 您可以 fork 后, 在 fork 项目中建立 Latest release Tag. |
| 28 | +GoHub 可以分析 fork 项目中的 Latest release Tag, 并正确获取文档. |
| 29 | + |
| 30 | +## 致谢 |
| 31 | + |
| 32 | +GoHub 的设计灵感来自 [FlatDoc][]. Powered by: |
| 33 | + |
| 34 | +- [jQuery][] New Wave JavaScript |
| 35 | +- [marked][] a markdown parser |
| 36 | +- [base64.js][] Base64 implementation for JavaScript |
| 37 | +- [highlight.js][] Syntax highlighting for the Web |
| 38 | + |
| 39 | + |
| 40 | +## LICENSE |
| 41 | + |
| 42 | +Copyright (c) 2015 The GoHub Authors. All rights reserved. |
| 43 | +Use of this source code is governed by a BSD-style license |
| 44 | +that can be found in the LICENSE file. |
| 45 | + |
| 46 | +[GoHub]: https://github.com/gohub/gohub.github.io |
| 47 | +[Wiki]: https://github.com/gohub/gohub.github.io/wiki |
| 48 | +[Issues]: https://github.com/gohub/gohub.github.io/issues |
| 49 | +[language-subtag]: http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry |
| 50 | +[Github Pages]: https://pages.github.com |
| 51 | +[GitHub API]: https://developer.github.com |
| 52 | +[RawGit]: http://rawgit.com |
| 53 | +[Golang-China]: https://github.com/golang-china |
| 54 | +[golangdoc.translations]: https://github.com/golang-china/golangdoc.translations |
| 55 | +[FlatDoc]: https://github.com/rstacruz/flatdoc |
| 56 | +[jQuery]: https://github.com/jquery/jquery |
| 57 | +[marked]: https://github.com/chjj/marked |
| 58 | +[highlight.js]: https://highlightjs.org |
| 59 | +[base64.js]: http://github.com/dankogai/js-base64 |
0 commit comments