https://github.com/yikeke/zh-style-guide
An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io
https://github.com/yikeke/zh-style-guide
hacktoberfest readthedocs style-guide technical-documentation
Last synced: 3 months ago
JSON representation
An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io
- Host: GitHub
- URL: https://github.com/yikeke/zh-style-guide
- Owner: yikeke
- License: mit
- Created: 2020-09-16T12:31:41.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T03:56:20.000Z (6 months ago)
- Last Synced: 2025-03-13T09:01:50.921Z (4 months ago)
- Topics: hacktoberfest, readthedocs, style-guide, technical-documentation
- Language: Python
- Homepage: https://zh-style-guide.readthedocs.io
- Size: 37.5 MB
- Stars: 902
- Watchers: 14
- Forks: 90
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starts - yikeke/zh-style-guide - An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io (Python)
- my-awesome - yikeke/zh-style-guide - guide,technical-documentation pushed_at:2025-01 star:1.0k fork:0.1k An open-source style guide for writing Chinese technical documents: https://zh-style-guide.readthedocs.io (Python)
README
# Call for a Maintainer! 招募一名仓库维护者~
由于我的目前精力变更，需要一名 active maintainer 帮助我维护仓库日常更新。维护者将会拥有直接合并 Pull Request 的权限。
如果有小伙伴感兴趣，请给 [email protected] 发邮件，有强烈热情和意愿的小伙伴优先，感谢！
# 中文技术文档写作风格指南
网页浏览地址：
本仓库存储的是《中文技术文档写作风格指南》的源文件，欢迎任何人进行贡献！
## 如何贡献
所有的源文件都存放在 /source 文件夹下：
- 配置文件为 conf.py 文件
- 各章节目录为各个 index.rst 文件
- 各章节页面为各个 xxx.md 文件
如需贡献，**请直接修改 /source 文件夹下的相应文件。**
## 为自己的公司创建一份风格指南
你可以点击右上角的 Fork 按钮，将该风格指南克隆到自己的仓库下，接着就可以按需自行修改了。
如果你成功在公司内部推广了这份风格指南，鼓励你在 [zh-style-guide 的使用者列表（完善中）](https://github.com/yikeke/zh-style-guide/discussions/26) 讨论区留下你的足迹。
每位 zh-style-guide 项目的实际使用者，都是社区的宝贵财富。每次与他人的连接，都会产生意想不到的价值！
## 相关博客文章
- [30 页的开源版中文技术文档写作风格指南，Web 端开放访问！](https://mp.weixin.qq.com/s/5znjT8FKJU08YS5lKFJvDA)
- [《风格指南》站的实现篇——如何在 30 分钟内制作一个美观的在线文档网站](https://mp.weixin.qq.com/s/7hfOOmhtJURewq8Fz7NhKg)
欢迎扫码关注我的微信公众号『阿狍杂谈』👉
介绍：我在互联网/IT/开源世界玩大冒险，在英语/心理/哲学世界学真心话。我所有的输赢得失，都在这儿讲给你听 :-)
## Repo stars
[](https://starchart.cc/yikeke/zh-style-guide)
## License
MIT
## Reference
- [Readthedocs 项目控制台](https://readthedocs.org/projects/zh-style-guide/builds)
- [Sphinx 入门 — Sphinx 1.8.5 文档](https://sphinx-doc.readthedocs.io/zh_CN/master/usage/quickstart.html#adding-content)
- [Specifying Dependencies — Read the Docs 5.4.3 documentation](https://docs.readthedocs.io/en/latest/guides/specifying-dependencies.html)
- [reStructuredText — Sphinx 1.8.5 文档](https://sphinx-doc.readthedocs.io/zh_CN/master/usage/restructuredtext/index.html)