zob
A style guide for coding and writing.
这里是一份关于编码和写作风格指导的项目。
作者现阶段的主要开发者角色是前端工程师,大部分编码是 JavaScript 方面的,所以在 coding
方面,主要针对 JS
、CSS
、HTML
这三个主要的内容进行编码风格的说明。
写作方面,本人的母语是中文,所以主要以中文排版方式为主。但作为一个技术从业者,大部分的文章更加偏向于技术,所以一般都是以中英文混排的形式出现。在本项目中将对这些写作风格进行详细的说明。
Coding
编码
JS
JS 这一块包括当前已经被广泛应用的 es5
,已经大部分支持的 es6
,还将包含 node
和 json
的一些说明。
CSS
作者倾向于使用原生 CSS 代码的编写方式,但是为了工作的方面,采用了 CSS 预处理器 LESS
,所以这个模块也对 LESS
的编码风格做一个说明。
HTML
与 CSS 类似,作者使用了多款 HTML 预处理工具,比如 ejs
、jade
/pug
、swig
等。
对于 HTML 的风格指导并不会太多,大都是一些语法上的规约。
Writing
技术的提升可以通过写作这种方式来提高。