Skip to content

Commit 321051a

Browse files
mikeescobedojonathantneal
authored andcommitted
Add .editorconfig h5bp#1561
Documentation
1 parent 4fca586 commit 321051a

File tree

3 files changed

+42
-0
lines changed

3 files changed

+42
-0
lines changed

Diff for: .editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
end_of_line = lf
7+
indent_size = 4
8+
indent_style = space
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

Diff for: CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
### HEAD
22

3+
* Add `/.editorconfig` file and documentation
4+
([#1561](https://github.com/h5bp/html5-boilerplate/issues/1561)).
35
* Add `auto` to the Google Universal Analytics tracker create method
46
([#1562](https://github.com/h5bp/html5-boilerplate/issues/1562)).
57
* Add `timeline` and `timelineEnd` to the list of `console` methods

Diff for: doc/misc.md

+27
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ table of contents](TOC.md)
44
# Miscellaneous
55

66
* [.gitignore](#gitignore)
7+
* [.editorconfig](#editorconfig)
78
* [.htaccess](#htaccess)
89
* [crossdomain.xml](#crossdomainxml)
910

@@ -32,6 +33,32 @@ globally ignore:
3233
* Comprehensive set of ignores on GitHub: https://github.com/github/gitignore
3334

3435

36+
## .editorconfig
37+
38+
HTML5 Boilerplate includes an `.editorconfig` file that helps you and your team
39+
define and maintain consistent coding styles between different editors and IDEs.
40+
EditorConfig files are easily readable and they work nicely with version control
41+
systems.
42+
43+
When opening any file, your IDE’s EditorConfig plugin will look for a file named
44+
`.editorconfig` in the directory of the opened file and in every parent
45+
directory until the root filepath is reached or an EditorConfig file with
46+
`root = true` is found.
47+
48+
The EditorConfig file provided by this project will inform your IDE to follow
49+
our current practices, which include UTF-8 charset encoding, use of the line
50+
feed character for line breaks, use of four space characters for indentations,
51+
the removal of any whitespace characters preceding newline characters, and the
52+
presence of a final line break character at the end of files.
53+
54+
If you will not be using a server configuration file provided by this project,
55+
remember to block access to `.editorconfig` files, as they may disclose
56+
sensitive information.
57+
58+
* [EditorConfig homepage](http://editorconfig.org/)
59+
* [Download IDE Plugin](http://editorconfig.org/#download)
60+
61+
3562
### `.htaccess`
3663

3764
A `.htaccess` (hypertext access) file is a Apache HTTP server configuration

0 commit comments

Comments
 (0)