{"id":13461684,"url":"https://github.com/yikeke/zh-style-guide","last_synced_at":"2025-03-24T22:34:54.022Z","repository":{"id":37084797,"uuid":"296026552","full_name":"yikeke/zh-style-guide","owner":"yikeke","description":"An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io","archived":false,"fork":false,"pushed_at":"2025-01-06T03:56:20.000Z","size":39369,"stargazers_count":902,"open_issues_count":1,"forks_count":90,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-03-13T09:01:50.921Z","etag":null,"topics":["hacktoberfest","readthedocs","style-guide","technical-documentation"],"latest_commit_sha":null,"homepage":"https://zh-style-guide.readthedocs.io","language":"Python","has_issues":true,"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/yikeke.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}},"created_at":"2020-09-16T12:31:41.000Z","updated_at":"2025-03-11T03:26:44.000Z","dependencies_parsed_at":"2024-01-11T17:47:08.898Z","dependency_job_id":"b4b1903c-6379-4fa4-adc9-f48a24ad783f","html_url":"https://github.com/yikeke/zh-style-guide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yikeke%2Fzh-style-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yikeke%2Fzh-style-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yikeke%2Fzh-style-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yikeke%2Fzh-style-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yikeke","download_url":"https://codeload.github.com/yikeke/zh-style-guide/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245366204,"owners_count":20603438,"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":["hacktoberfest","readthedocs","style-guide","technical-documentation"],"created_at":"2024-07-31T11:00:52.428Z","updated_at":"2025-03-24T22:34:49.010Z","avatar_url":"https://github.com/yikeke.png","language":"Python","funding_links":[],"categories":["Popular \u0026 New Non-LaTeX Templates","Python"],"sub_categories":["Others"],"readme":"# Call for a Maintainer! 招募一名仓库维护者~\n\n由于我的目前精力变更，需要一名 active maintainer 帮助我维护仓库日常更新。维护者将会拥有直接合并 Pull Request 的权限。\n\n如果有小伙伴感兴趣，请给 yicoco17@gmail.com 发邮件，有强烈热情和意愿的小伙伴优先，感谢！\n\n# 中文技术文档写作风格指南\n\n网页浏览地址：\u003chttps://zh-style-guide.readthedocs.io\u003e\n\n本仓库存储的是《中文技术文档写作风格指南》的源文件，欢迎任何人进行贡献！\n\n## 如何贡献\n\n所有的源文件都存放在 /source 文件夹下：\n\n- 配置文件为 conf.py 文件\n- 各章节目录为各个 index.rst 文件\n- 各章节页面为各个 xxx.md 文件\n\n如需贡献，**请直接修改 /source 文件夹下的相应文件。**\n\n## 为自己的公司创建一份风格指南\n\n你可以点击右上角的 Fork 按钮，将该风格指南克隆到自己的仓库下，接着就可以按需自行修改了。\n\n如果你成功在公司内部推广了这份风格指南，鼓励你在 [zh-style-guide 的使用者列表（完善中）](https://github.com/yikeke/zh-style-guide/discussions/26) 讨论区留下你的足迹。\n\n每位 zh-style-guide 项目的实际使用者，都是社区的宝贵财富。每次与他人的连接，都会产生意想不到的价值！\n\n## 相关博客文章\n\n\u003cimg align=\"right\" src=\"qrcode.jpg\" alt=\"微信公众号二维码：阿狍杂谈\" height=\"150\" /\u003e\n\n- [30 页的开源版中文技术文档写作风格指南，Web 端开放访问！](https://mp.weixin.qq.com/s/5znjT8FKJU08YS5lKFJvDA)\n- [《风格指南》站的实现篇——如何在 30 分钟内制作一个美观的在线文档网站](https://mp.weixin.qq.com/s/7hfOOmhtJURewq8Fz7NhKg)\n\n欢迎扫码关注我的微信公众号『阿狍杂谈』👉\n\n介绍：我在互联网/IT/开源世界玩大冒险，在英语/心理/哲学世界学真心话。我所有的输赢得失，都在这儿讲给你听 :-)\n\n## Repo stars\n\n[![Stargazers over time](https://starchart.cc/yikeke/zh-style-guide.svg)](https://starchart.cc/yikeke/zh-style-guide)\n\n## License\n\nMIT\n\n## Reference\n\n- [Readthedocs 项目控制台](https://readthedocs.org/projects/zh-style-guide/builds)\n\n- [Sphinx 入门 — Sphinx 1.8.5 文档](https://sphinx-doc.readthedocs.io/zh_CN/master/usage/quickstart.html#adding-content)\n\n\u003c!-- - [readthedocs/recommonmark: A markdown parser for docutils](https://github.com/readthedocs/recommonmark#linking-to-headings-in-other-files) --\u003e\n\n- [Specifying Dependencies — Read the Docs 5.4.3 documentation](https://docs.readthedocs.io/en/latest/guides/specifying-dependencies.html)\n\n- [reStructuredText — Sphinx 1.8.5 文档](https://sphinx-doc.readthedocs.io/zh_CN/master/usage/restructuredtext/index.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyikeke%2Fzh-style-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyikeke%2Fzh-style-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyikeke%2Fzh-style-guide/lists"}