其它事项
- .gitignore
- .editorconfig
- 服务器配置
- robots.txt
- browserconfig.xml
--
.gitignore
HTML5 Boilerplate包含一个基本的项目级别的.gitignore
文件。主要用于避免某些项目级别的文件和目录被保存在源代码管理下。不同的开发环境将受益于不同的忽略集合。
应使用作用于系统上所有仓库的"全局忽略"来忽略特定于操作系统和编辑器的文件。
例如,你的HOME目录中的.gitignore
包含要全局忽略的文件和目录,将以下内容添加到~/.gitconfig
中:
[core]
excludesfile = ~/.gitignore
- 全局忽略的更多信息: https://help.github.com/articles/ignoring-files/
- Github上全面的忽略集合: https://github.com/github/gitignore
.editorconfig
提供.editorconfig
文件,以鼓励和帮助你和你的团队在不同的编辑器和IDE之间,定义和维护一致的编码风格。
默认情况下,.editorconfig
包括一些基本的属性,它们反映了默认提供的文件的编码风格,但是你可以轻松地更改它们以更好地满足你的需要。
为了让.editorconfig
文件中的属性作用于你的编辑器/IDE,你可能需要安装一个插件。
注意 如果你没有使用HTML5 Boilerplate提供的服务器配置,我们强烈建议你将服务器配置为阻止访问.editorconfig
文件,因为它们会泄露敏感信息!
更多详细信息,请参考EditorConfig项目。
服务器配置
H5BP包含Apache HTTP服务器的.htaccess
文件。如果你没有使用Apache作为Web服务器,建议你下载适合你的Web服务器和环境的服务器配置。
.htaccess
(超文本访问)文件是一个Apache HTTP服务器配置文件。
.htaccess
文件主要用于:
- 重写URL
- 控制缓存
- 认证
- 服务器端包含
- 重定向
- gzip压缩
如果你可以访问主服务器配置文件(通常叫作httpd.conf
),你应该把.htaccess
文件中的逻辑添加进去,例如,主配置文件中的Directory
部分。这通常是推荐的做法,因为使用.htaccess文件会托慢Apache!
要在本地启用Apache模块,请参考:
https://github.com/h5bp/server-configs-apache/wiki/How-to-enable-Apache-modules。
在上面的仓库中,.htaccess
用户:
- 允许跨域访问Web字体
- CORS头用于浏览器请求图片
- 启用
404.html
作为404错误文档 - 为IE用户提供更好的网站体验
- UTF-8作为
text/html
和text/plain
的字符编码 - 启用重写URL引擎
- 强制添加或删除URL开头的
www.
- 阻止对没有默认文档的目录的访问
- 阻止访问可能暴露敏感信息的文件
- 降低MIME类型的安全风险
- 强制压缩(gzipping)
- 告诉浏览器是否应该从服务器请求一个特定的文件,还是从浏览器的缓存中抓取它
当使用.htaccess
时,我们建议读取一次文件内所有的内联注释(#
后面的规则)。它包含一堆可选的选项。
如果你想了解更多关于.htaccess
文件的信息,请查看Apache HTTP服务器文档或更具体的htaccess部分。
请注意,.htaccess
文件的原始仓库是这个。
robots.txt
robots.txt
文件用于向Web机器人发出网站上哪些内容可以被抓取的说明。
默认情况下,此项目提供的文件包含以下两行:
User-agent: *
- 以下规则适用于所有Web机器人Disallow:
- 网站上的所有内容都被允许抓取
如果不想某些页面被抓取,则需要在Disallow
指令中指定路径(例如:Disallow: /path
),或者,如果不想所有内容被抓取,使用Disallow: /
。
/robots.txt
文件不是为了访问控制,所以不要为此而试图使用它。把它看作是一个”禁止入内”的标志,而不是一扇被锁住的门。robots.txt
文件禁止的URL可能仍然被索引而不被抓取,任何人都可以查看robots.txt
文件内的内容,可能泄露私人内容的位置!因此,如果你想阻止访问私人内容,请使用正确的认证代替。
有关robots.txt
的更多信息,请参考:
browserconfig.xml
browserconfig.xml
文件用于自定义用户将你的网站固定到Windows 8.1启动菜单时显示的磁贴。你可以自定义磁贴颜色、磁贴图片、甚至动态磁贴。
By default, the file points to 2 placeholder tile images:
默认情况下,文件指向2张占位图片:
tile.png
(558x558px): 用于小
、中
和大
磁贴。必要时图片自动调整大小。tile-wide.png
(558x270px): 用于宽
磁贴。
请注意,IE11用户将网站添加到收藏夹
时,会使用相同的图片。
关于browserconfig.xml
文件更深入的信息,请查看MSDN。