GoHub在線 Golang 文檔閱讀
GoHub 基于 Github Pages 提供在線 Golang 文檔閱讀.。特征：
便捷的文檔項(xiàng)目組織
Go Doc API 翻譯雙語對(duì)照閱讀
渲染 Markdown 或更多編程語言文檔
對(duì) GoHub 有任何建議或問題, 請(qǐng)至 GoHub Wiki 和 Issues
實(shí)現(xiàn)基礎(chǔ)
得益于 GitHub API 和 RawGit, GoHub 項(xiàng)目代碼和 Golang 翻譯文檔項(xiàng)目代碼是分離的。GoHub 通過 GitHub API 獲取項(xiàng)目的 Latest release Tag，從 RawGit CDN 獲取該 Tag 下的文檔。RawGit CDN 中的數(shù)據(jù)是靜態(tài)的, 不提供更新服務(wù)。更新 Latest release Tag 可使 GoHub 展現(xiàn)新的文檔. 對(duì)于沒有建立 Latest release Tag 的項(xiàng)目, 您可以 fork 后, 在 fork 項(xiàng)目中建立 Latest release Tag。
組織方式
GoHub 使用文件 golist.json 來組織文檔項(xiàng)目. 為簡(jiǎn)化邏輯使用兩種結(jié)構(gòu).
Object方式 表示包文檔索引: 全部以 Object 組織, list 為子包列表.
{
"std": {
"type": "doc_zh_CN.go",
"repo": "golang-china/golangdoc.translations/src",
"list": {
"archive/tar": "tar包實(shí)現(xiàn)了tar格式壓縮文件的存取.",
"archive/zip": "zip包提供了zip檔案文件的讀寫服務(wù)."
}
}
}
數(shù)組方式 表示項(xiàng)目索引: 每個(gè)條目都是 GitHub 上得一個(gè)項(xiàng)目, repo 下必須含有 golist.json 文件. 該文件內(nèi)容可以為包文檔索引或者包文檔索引.
[
{
"repo": "golang-china/golangdoc.translations",
"description": "Go std 文檔"
},
{
"repo": "gohub/google",
"description":"Google Go 文檔"
}
]
GoHub 的 golist.json 為文檔源頭, repo 所有者通過定義 golist.json 自由拓?fù)湮臋n關(guān)系.
Go 標(biāo)準(zhǔn)庫
GoLang 標(biāo)準(zhǔn)庫的翻譯文檔來自 Golang-China 的 golangdoc.translations 項(xiàng)目。期待您參與該項(xiàng)目并改善翻譯文檔.
致謝
GoHub 的設(shè)計(jì)靈感來自 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