{"id":15107073,"url":"https://github.com/jpush/jpush-docs","last_synced_at":"2025-09-27T05:31:37.417Z","repository":{"id":17596724,"uuid":"20400411","full_name":"jpush/jpush-docs","owner":"jpush","description":"JPush docs on official website. 极光推送官方文档。","archived":true,"fork":false,"pushed_at":"2019-08-09T11:49:11.000Z","size":162980,"stargazers_count":115,"open_issues_count":1,"forks_count":81,"subscribers_count":31,"default_branch":"master","last_synced_at":"2024-12-16T11:53:06.402Z","etag":null,"topics":["docs","jiguang","jpush","mkdocs"],"latest_commit_sha":null,"homepage":"https://docs.jiguang.cn","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jpush.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}},"created_at":"2014-06-02T10:32:47.000Z","updated_at":"2024-02-28T03:15:43.000Z","dependencies_parsed_at":"2022-09-11T15:31:28.945Z","dependency_job_id":null,"html_url":"https://github.com/jpush/jpush-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpush%2Fjpush-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpush%2Fjpush-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpush%2Fjpush-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jpush%2Fjpush-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jpush","download_url":"https://codeload.github.com/jpush/jpush-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234391380,"owners_count":18824809,"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":["docs","jiguang","jpush","mkdocs"],"created_at":"2024-09-25T21:04:12.590Z","updated_at":"2025-09-27T05:31:32.364Z","avatar_url":"https://github.com/jpush.png","language":"HTML","readme":"JPush Docs\n==========\n\n## Get Started\n\n1. 安装 Python（Python 2.7 和 Python 3 都可以，推荐 Python 3）\n\n2. 安装 MKDocs\n\n```bash\n$ pip install mkdocs\n```\n\n3. `clone` 代码到本地\n\n4. 同步 README（Windows 用户需在 Git 命令行环境下执行）\n\n```bash\n$ bash ./hooks/synreadme.sh\n```\n\n5. 运行 `MKDocs` 测试服务器\n\n```bash\n$ mkdocs serve\n```\n\n6. 使用浏览器访问：\n\n```\nhttp://127.0.0.1:8000/\n```\n\n## Github Webhook\n\n1. 安装 Python 3\n\n2. 创建并激活虚拟环境 `venv`\n\n```bash\n$ python -m venv venv\n$ . ./venv/bin/activate\n```\n\n3. 安装依赖\n\n```bash\n$ pip install -r requirements.txt\n```\n\n4. 复制配置文件\n\n```bash\n$ cp hooks/hooksrc.sample hooks/hooksrc\n$ cp hooks/uwsgi.ini.sample hooks/uwsgi.ini\n```\n\n5. 同步 README\n\n```bash\n$ bash ./hooks/synreadme.sh\n```\n\n6. 使用服务器\n\n- 使用 `Flask` 自带服务器\n\n```bash\n$ python hooks/webhooks.py\n```\n\n- 使用 `uWSGI` 作为服务器 (`[]`表示可选命令行参数)\n\n\u003e 需要把 `uWSGI` 的配置文件 `hooks/uwsgi.ini` 中的一行配置项 `socket = 127.0.0.1:8080` 改成 `http-socket = 127.0.0.1:8080`\n\n```bash\n$ uwsgi -i hooks/uwsgi.ini [ \u0026\u003e\u003e uwsgi.log [\u0026]]\n```\n\n- 使用 `Nginx` 管理 `uWSGI`\n\n\u003e 需要保留 `uWSGI` 的配置文件 `hooks/uwsgi.ini` 中的 `socket = 127.0.0.1:8080` 配置项\n\n7. 使用浏览器访问（Flask 服务器和 uWSGI 服务器）：\n\n```\nhttp://127.0.0.1:8080\n```\n\n返回 `Hello World` 则说明 github webhook 配置部署成功。\n\n## Contributing\n\n1. 同步 `JPush` 上游仓库的更新到自己的远端仓库\n2. 更新文档\n3. 提交文档到自己远端仓库\n4. 提 `Pull Request` 到 JPush 上游仓库的 `master` 分支\n\n## MKDocs\n本文档基于 `Markdown` 编写，使用 [MKDocs](https://github.com/tomchristie/mkdocs) 工具生成 HTML 布局与页面。\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpush%2Fjpush-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjpush%2Fjpush-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjpush%2Fjpush-docs/lists"}