Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stevending1st/awesome-document-style-guide

A list of awesome document style guide.
https://github.com/stevending1st/awesome-document-style-guide

List: awesome-document-style-guide

Last synced: 15 days ago
JSON representation

A list of awesome document style guide.

Awesome Lists containing this project

README 

        
# Awesome Document Style Guide



A list of awesome document style guide.



## Specifications



### 中文



- [党政机关公文格式（GB/T 9704-2012）](https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=F3CC9BEF482524C895FDA7A08BB4A70E)



- [Requirements for Chinese Text Layout

（中文排版需求）](https://www.w3.org/TR/clreq/) (by [w3c](https://www.w3.org/))



- [中文技术文档的写作规范](https://github.com/ruanyf/document-style-guide) (by [阮一峰](https://github.com/ruanyf))



- [泛化智能文风指南（gi Style Guide）](https://github.com/generalized-intelligence/gi-Chinese-Style-Guide)：用于中文写作的文风指南，泛化智能出品。



- [中文技术文档写作风格指南](https://github.com/yikeke/zh-style-guide/)：An open-source style guide for writing Chinese technical documents. [website](https://zh-style-guide.readthedocs.io)



- [文案风格指南](https://open.leancloud.cn/copywriting-style-guide/)



- [中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines): 统一中文文案、排版的相关用法，降低团队成员之间的沟通成本，增强网站气质。



  - [中文文案排版指北](https://github.com/mzlogin/chinese-copywriting-guidelines): 统一中文文案、排版的相关用法，降低团队成员之间的沟通成本，增强网站气质。[website](https://mazhuang.org/wiki/chinese-copywriting-guidelines/) (by [闷骚的程序员](https://mazhuang.org/))



  - [中文文案排版指北 - LCTT](https://lctt.github.io/wiki/tutorials/copywriting.html): 本文最初来自：[中文文案排版指北](https://github.com/sparanoid/chinese-copywriting-guidelines)，根据 LCTT 使用体验有修订。统一中文文案、排版的相关用法，降低团队成员之间的沟通成本，增强网站气质。



- [中文博客排版指南](https://github.com/qianguyihao/document-guide)



- [豌豆荚文案风格指南](https://docs.google.com/document/d/1R8lMCPf6zCD5KEA8ekZ5knK77iw9J-vJ6vEopPemqZM/edit#heading=h.wwm9rx-11m0cb)



- [简体中文文本排版指南](https://zhuanlan.zhihu.com/p/49729668) (by [蔡振原](https://www.zhihu.com/people/cai-zhen-yuan-40))

  - [如何只用文本就排出精致感（上）](https://mp.weixin.qq.com/s/oT00r3EQ83cRvm_FRg94iw)

  - [如何只用文本就排出精致感（下）](https://mp.weixin.qq.com/s/FQuR10YvdmrQQUfBwPj-Zg)



- [中文排版的最佳实践](https://zhuanlan.zhihu.com/p/19891152)



- [写给大家看的中文排版指南](https://zhuanlan.zhihu.com/p/20506092)



- [Markdown 中文排版指南](https://breezetemple.github.io/2019/10/11/chinese-copywriting-guidelines/): 中文排版指南及 Markdown + Vim 工具。



- [开发工具总结（9）之开源项目的README文档的最全最规范写法](https://www.jianshu.com/p/813b70d5b0de) ([GitHub](https://github.com/AweiLoveAndroid/CommonDevKnowledge/blob/master/github_README/README%E6%96%87%E6%A1%A3%E7%9A%84%E8%A7%84%E8%8C%83%E5%86%99%E6%B3%95.md))



- [每个人都需要的中文排版指南](https://mp.weixin.qq.com/s/k5DAmYtMrdSlK1jHsW-hrg) (by  stormzhang)



- [这是曹将公众号排版的所有秘密！](https://mp.weixin.qq.com/s/DEUUcO4FhCiIYmh61wGXnw) (by 曹将)



- [格式 - SUSE](https://zh.opensuse.org/index.php?title=Help:%E6%A0%BC%E5%BC%8F)



- [别再用「六个点」当省略号了，这些标点都有更规范的输入方式](https://sspai.com/post/45516) (by [PlatyHsu](https://sspai.com/u/platyhsu/updates))



- [大眾字型學](https://blog.justfont.com/tag/popular-typography/): 電腦字型早已大眾化。不必特別購買，每台電腦都有好多字型，足夠提供一般用途使用，例如製作簡單的個人履歷、投影片或報告等。但是，字型背後的知識卻沒有如此普及。大眾字型學系列文章，就是要為每個用字的人介紹使用字型的基本知識。



- [中文排版指北·初稿](https://zhuanlan.zhihu.com/p/41877056): 目前中文排版是个很复杂的问题，当代中文排版相比古代中文排版复杂了很多，古时候只有繁体竖排而使用环境也只有书籍、公文。自近代以来中文开始引入阿拉伯数字、西文字符后来中文也制定了中文字符并采用横排，但是由于历史遗留问题中文出现了简体中文与繁体中文及横竖排共存的状态另外西文与西文字符也以中英文混排的形式存在于中文文章之中。如今中文的使用环境也从原来简单的书籍、公文发展到书籍、杂志、办公文档、公文、网站、应用等多种使用环境再加上近几年来自媒体的蓬勃发展，可排版水平却参差不齐中文排版的重要性不言而喻。相比于日文、西文的排版，现行的中文排版还没有一个统一的标准。



- [余光中：怎样改进英式中文？- 论中文的常态与变态](https://open.leancloud.cn/improve-chinese/)



### English



- [developer documentation style guide](https://developers.google.cn/style/): This style guide provides editorial guidelines for writing clear and consistent Google-related developer documentation.



## Tools



- [markdownlint](https://github.com/DavidAnson/markdownlint): A Node.js style checker and lint tool for Markdown/CommonMark files.



- [Tekorrect](https://github.com/n0vad3v/Tekorrect): 此 Python 腳本用於給已經完成的 Markdown 遍寫的文檔進行優化，它會將壹些非標準，或不推薦的排版方式，進行自動格式化、標準化。



- [Lint Markdown 2.0](https://github.com/lint-md/lint-md): 📚 检查中文 markdown 编写格式规范的命令行工具，基于 AST，方便集成 CI，写博客 / 文档必备。支持 API 调用！



- 「盘古之白」

  - [pangu.js](https://github.com/vinta/pangu.js): Paranoid text spacing in JavaScript.



  - [pangu.py](https://github.com/vinta/pangu.py): Paranoid text spacing in Python.



  - [pángǔ.vim](https://github.com/hotoo/pangu.vim): 『盘古之白』中文排版自动规范化的 Vim 插件。



## Podcast



- [Episode 7: 我们开源了文风指南，就是那个很多人听说过却没见过的东西](https://www.listennotes.com/podcasts/%E7%A4%BE%E4%BC%9A%E4%BA%BA%E7%A7%91%E6%8A%80%E8%AF%84%E8%AE%BA/episode-7-XKeEs2icvkg/) （by 社会人科技评论）



## License



CC0-1.0 license