Go 風格文檔在線閱讀
GoHub 基于 Github Pages 提供在線 Golang 文檔閱讀.。特征：
-
便捷的文檔項目組織
-
Go Doc API 翻譯雙語對照閱讀
-
渲染 Markdown 或更多編程語言文檔
對 GoHub 有任何建議或問題, 請至 GoHub Wiki 和 Issues
實現基礎
得益于 GitHub API 和 RawGit, GoHub 項目代碼和 Golang 翻譯文檔項目代碼是分離的。GoHub 通過 GitHub API 獲取項目的 Latest release Tag，從 RawGit CDN 獲取該 Tag 下的文檔。RawGit CDN 中的數據是靜態的, 不提供更新服務。更新 Latest release Tag 可使 GoHub 展現新的文檔. 對于沒有建立 Latest release Tag 的項目, 您可以 fork 后, 在 fork 項目中建立 Latest release Tag。
組織方式
GoHub 使用文件 golist.json 來組織文檔項目. 為簡化邏輯使用兩種結構.
Object方式 表示包文檔索引: 全部以 Object 組織, list 為子包列表.
{
"std": {
"type": "doc_zh_CN.go",
"repo": "golang-china/golangdoc.translations/src",
"list": {
"archive/tar": "tar包實現了tar格式壓縮文件的存取.",
"archive/zip": "zip包提供了zip檔案文件的讀寫服務."
}
}
} 數組方式 表示項目索引: 每個條目都是 GitHub 上得一個項目, repo 下必須含有 golist.json 文件. 該文件內容可以為包文檔索引或者包文檔索引.
[
{
"repo": "golang-china/golangdoc.translations",
"description": "Go std 文檔"
},
{
"repo": "gohub/google",
"description":"Google Go 文檔"
}
] GoHub 的 golist.json 為文檔源頭, repo 所有者通過定義 golist.json 自由拓撲文檔關系.
Go 標準庫
GoLang 標準庫的翻譯文檔來自 Golang-China 的 golangdoc.translations 項目。期待您參與該項目并改善翻譯文檔.
致謝
GoHub 的設計靈感來自 FlatDoc。Powered by：
-
jQuery New Wave JavaScript
-
marked a markdown parser
-
base64.js Base64 implementation for JavaScript
-
highlight.js Syntax highlighting for the Web
-
JingYes CSS3 Framework