没有最好的组织方式,只有最合适的。
扁平化
- src 放置源代码
-css
-login.css
-main.css
-normalize.css
-js
-vendor(第三方库)
-jquery.js
-main.js
-tpl
-swf
-less
-sass
-img
-index.html
-login.html
-404.html
-robots.txt
-humans.txt
- doc 项目相关文档,需求文档,设计图
- othersrc
-home
-css
-js
-img
-login
-customer
-css
-js
-img
-common通用样式,脚本,图片
-css
-js
-img
-component
-alert
-grid
-tabpanel
- dist 存放处理后的发布文件
- test 测试文件
- .editorconfig保证团队成员使用不同的编辑器能够保持统一的代码格式
- .gitignore 配置文件用于配置不需要加入版本管理的文件
- LICENSE.txt 命名使用大写,版权声明,协议内容(有些文件是你用了它(开源),你也要开源)
- README.md 项目简介,使用方式,相关链接
- CHANGLOG.md 项目每个版本的更新(说明版本号,更新内容,修复额哪些问题等)
Robots协议(也称为爬虫协议、机器人协议等)的全称是“网络爬虫排除标准”(Robots Exclusion Protocol),网站通过Robots协议告诉搜索引擎哪些页面可以抓取,哪些页面不能抓取。
EditorConfig文件使用INI格式。斜杠(/)作为路径分隔符,#或者;作为注释。EditorConfig文件使用UTF-8格式、CRLF或LF作为换行符。
备注
root = true 最顶层的配置文件
[*] 应用所有的文件
charset= utf-8
utf-8-bom不要用,php之“锘”,UTF-8因为它的编码特性,是字节序无关的,所以不需要BOM。这个锅,window是背定了。跨平台容易出现问题,主要是unix是不鸟bom的。
indent_size= 4缩进
indent_style = space
insert_final_newline = true 每一个文件以一个空白行结尾
trim_trailing_whitespace = true 去除空白行空格的字符
[*.md]
trim_trailing_whitespace = false
对于编辑器来说,会优先使用editorconfig的规则
md=markdown(webstorm使用multimarkdown插件)
具体使用方式:http://wowubuntu.com/markdown/