{"id":17660894,"url":"https://github.com/soulteary/docker-quick-docs","last_synced_at":"2025-10-19T04:20:30.187Z","repository":{"id":215410252,"uuid":"738816798","full_name":"soulteary/docker-quick-docs","owner":"soulteary","description":"本地部署、能够快速访问的文档工具，用来改善 GitHub Pages 文档访问体验。","archived":false,"fork":false,"pushed_at":"2025-05-26T12:22:12.000Z","size":184,"stargazers_count":17,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-22T14:08:32.120Z","etag":null,"topics":["docker-github-pages","github","github-page","github-pages"],"latest_commit_sha":null,"homepage":"https://soulteary.com/2024/01/04/improving-the-github-pages-reading-experience-quick-docs.html","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/soulteary.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-01-04T05:39:56.000Z","updated_at":"2025-03-17T12:54:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"6e30bed5-1d61-4796-86be-1f2f67f9dcd4","html_url":"https://github.com/soulteary/docker-quick-docs","commit_stats":{"total_commits":24,"total_committers":3,"mean_commits":8.0,"dds":"0.41666666666666663","last_synced_commit":"63785d239acc75e766e8dfa9a51b3d3bd5307aa0"},"previous_names":["soulteary/docker-quick-docs"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/soulteary/docker-quick-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-quick-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-quick-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-quick-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-quick-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/soulteary","download_url":"https://codeload.github.com/soulteary/docker-quick-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/soulteary%2Fdocker-quick-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261304268,"owners_count":23138301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-github-pages","github","github-page","github-pages"],"created_at":"2024-10-23T17:09:37.588Z","updated_at":"2025-10-19T04:20:25.153Z","avatar_url":"https://github.com/soulteary.png","language":"Go","readme":"# Docker Quick Docs\n\n[![Release](https://github.com/soulteary/docker-quick-docs/actions/workflows/release.yaml/badge.svg)](https://github.com/soulteary/docker-quick-docs/actions/workflows/release.yaml) [![Codecov](https://github.com/soulteary/docker-quick-docs/actions/workflows/codecov.yml/badge.svg)](https://github.com/soulteary/docker-quick-docs/actions/workflows/codecov.yml) [![CodeQL](https://github.com/soulteary/docker-quick-docs/actions/workflows/codeql.yml/badge.svg)](https://github.com/soulteary/docker-quick-docs/actions/workflows/codeql.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/soulteary/docker-quick-docs)](https://goreportcard.com/report/github.com/soulteary/docker-quick-docs)\n\n本地部署、能够快速访问的文档工具，用来改善 GitHub Pages 文档访问体验。\n\n## 下载工具\n\n在 GitHub [发布页面](https://github.com/soulteary/docker-quick-docs/releases) 下载适合你操作系统的可执行文件。\n\n![](.github/assets.jpg)\n\n或者使用 Docker 下载工具：\n\n![](.github/dockerhub.jpg)\n\n```bash\ndocker pull soulteary/docker-quick-docs:v0.1.7\n# 或者\ndocker pull soulteary/docker-quick-docs\n```\n\n## 使用工具\n\n以 [baidu/san](http://github.com/baidu/san) 为例，我们将这个软件的 GitHub 进行本地化部署。\n\n首先，获取想本地部署的软件的文档代码，GitHub Pages，通常需要下载 GitHub 的 `gh-pages` 分支：\n\n```bash\ngit clone http://github.com/baidu/san --depth 1 --branch=gh-pages\nCloning into 'san'...\nwarning: redirecting to https://github.com/baidu/san/\nremote: Enumerating objects: 405, done.\nremote: Counting objects: 100% (405/405), done.\nremote: Compressing objects: 100% (197/197), done.\nremote: Total 405 (delta 154), reused 303 (delta 65), pack-reused 0\nReceiving objects: 100% (405/405), 2.17 MiB | 5.18 MiB/s, done.\nResolving deltas: 100% (154/154), done.\n```\n\n然后，我们可以将这些文档放到 `docs` 目录中。\n\n```bash\nmv san docs/\n```\n\n然后我们执行程序即可：\n\n```bash\n# 如果你选择使用可执行文件\n./quick-docs\n\n# 如果你选择使用 docker\ndocker run --rm -it -v `pwd`/docs:/app/docs -p 8080:8080 soulteary/docker-quick-docs:v0.1.7\n```\n\n程序执行完毕，我们将看到类似下面的日志：\n\n```bash\n2024/01/04 10:38:31 Quick Docs\n2024/01/04 10:38:31 未设置环境变量 `PORT`，使用默认端口：8080\n```\n\n此时访问浏览器，就能够快速的访问文档啦。\n\n## 配置\n\n如果你想调整端口，可以设置 `PORT` 环境变量。\n\n例如：\n\n```bash\nPORT=8080 ./quick-docs\n# 或\ndocker run --rm -it -e PORT=8080 -v `pwd`/docs:/app/docs -p 8080:8080 soulteary/docker-quick-docs:v0.1.7\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoulteary%2Fdocker-quick-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoulteary%2Fdocker-quick-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoulteary%2Fdocker-quick-docs/lists"}