You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* feat: turn headers into links
* create subsections for plugin types
* change back `download-plugin` id to `download`
* remove extra `#` in IDs
* Update index.html
* contribute section: `#editor-plugin` -> `#download`
Copy file name to clipboardExpand all lines: index.html
+86-51Lines changed: 86 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -5,20 +5,26 @@
5
5
6
6
<sectionid="overview">
7
7
8
-
<h2>What is EditorConfig?</h2>
8
+
<ahref="#overview" class="anchor">
9
+
<h2>What is EditorConfig?</h2>
10
+
</a>
9
11
10
12
<p>EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of <strong>a file format</strong> for defining coding styles and a collection of <strong>text editor plugins</strong> that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.</p>
11
13
12
14
</section>
13
15
14
16
<sectionid="file-format">
15
17
16
-
<h2>What's an EditorConfig file look like?</h2>
18
+
<ahref="#file-format" class="anchor">
19
+
<h2>What's an EditorConfig file look like?</h2>
20
+
</a>
17
21
18
22
<p><em>(A <ahref="https://spec.editorconfig.org/">formal specification of EditorConfig</a> is also available.)</em></p>
19
23
20
24
<sectionid="example-file">
21
-
<h3>Example file</h3>
25
+
<ahref="#example-file" class="anchor">
26
+
<h3>Example file</h3>
27
+
</a>
22
28
<p>Below is an example <code>.editorconfig</code> file setting end-of-line and indentation styles for Python and JavaScript files.</p>
23
29
<divclass="code-container">
24
30
{% highlight ini %}
@@ -61,7 +67,9 @@ <h3>Example file</h3>
61
67
</section>
62
68
63
69
<sectionid="file-location">
64
-
<h3>Where are these files stored?</h3>
70
+
<ahref="#file-location" class="anchor">
71
+
<h3>Where are these files stored?</h3>
72
+
</a>
65
73
66
74
<p>When opening a file, EditorConfig plugins look for a file named <code>.editorconfig</code> (all lowercase) in the directory of the opened file and in every parent directory. A search for <code>.editorconfig</code> files will stop if the root filepath is reached or an EditorConfig file with <code>root=true</code> is found.</p>
67
75
@@ -71,15 +79,19 @@ <h3>Where are these files stored?</h3>
71
79
</section>
72
80
73
81
<sectionid="file-format-details">
74
-
<h3>File Format Details</h3>
82
+
<ahref="#file-format-details" class="anchor">
83
+
<h3>File Format Details</h3>
84
+
</a>
75
85
76
86
<p>EditorConfig files use an INI format that is compatible with the format used by <ahref="https://docs.python.org/2/library/configparser.html">Python ConfigParser Library</a>, but <code>[</code> and <code>]</code> are allowed in the section names. The section names are filepath <ahref="https://en.wikipedia.org/wiki/Glob_(programming)">globs</a> (case sensitive), similar to the format accepted by <ahref="https://git-scm.com/docs/gitignore#_pattern_format">gitignore</a>. Only forward slashes (<code>/</code>, not backslashes) are used as path separators and octothorpes (<code>#</code>) or semicolons (<code>;</code>) are used for comments. Comments should go on their own lines. EditorConfig files should be UTF-8 encoded, with either <code><abbrtitle="Carriage Return Line Feed">CRLF</abbr></code> or <code><abbrtitle="Line Feed">LF</abbr></code> line separators. EditorConfig files are read top to bottom and the most recent rules found take precedence.</p>
77
87
78
88
<p>Filepath glob patterns and currently-supported EditorConfig properties are explained below.</p>
79
89
</section>
80
90
81
91
<sectionid="wildcards">
82
-
<h4>Wildcard Patterns</h4>
92
+
<ahref="#wildcards" class="anchor">
93
+
<h4>Wildcard Patterns</h4>
94
+
</a>
83
95
84
96
<p>Special characters recognized in section names for wildcard matching:</p>
85
97
@@ -97,7 +109,9 @@ <h4>Wildcard Patterns</h4>
97
109
</section>
98
110
99
111
<sectionid="supported-properties">
100
-
<h4>Supported Properties</h4>
112
+
<ahref="#supported-properties" class="anchor">
113
+
<h4>Supported Properties</h4>
114
+
</a>
101
115
<p>Note that not all properties are supported by every plugin. The wiki has a <ahref="https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties">complete list of properties</a>.</p>
102
116
<ulclass="property-definitions">
103
117
<li><dfn><code>indent_style</code></dfn>: set to <q>tab</q> or <q>space</q> to use hard tabs or soft tabs respectively.</li>
@@ -120,7 +134,9 @@ <h4>Supported Properties</h4>
120
134
121
135
<sectionid="pre-installed">
122
136
123
-
<h2>No Plugin Necessary</h2>
137
+
<ahref="#pre-installed" class="anchor">
138
+
<h2>No Plugin Necessary</h2>
139
+
</a>
124
140
125
141
<p>These editors come bundled with native support for EditorConfig. Everything should just work.</p>
<li><ahref="https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig"><imgsrc="logos/visualstudio-code.png" alt="Visual Studio Code"><span>Visual Studio Code</span></a></li>
196
-
</ul>
184
+
<ahref="#download" class="anchor">
185
+
<h2>Download a Plugin</h2>
186
+
</a>
187
+
188
+
<sectionid="editor-plugins">
189
+
<ahref="#editor-plugins" class="anchor">
190
+
<h3>Editor</h3>
191
+
</a>
192
+
193
+
<p>To use EditorConfig with one of these editors, you will need to install a plugin.</p>
<li><ahref="https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig"><imgsrc="logos/visualstudio-code.png" alt="Visual Studio Code"><span>Visual Studio Code</span></a></li>
218
+
</ul>
197
219
198
-
<divstyle="clear: both;"></div>
220
+
<divstyle="clear: both;"></div>
221
+
</section>
199
222
200
-
<h3>Headless Tool</h3>
201
-
<p>To use EditorConfig with one of these headless tools, you will need to install a plugin.</p>
223
+
<sectionid="headless-tool-plugins">
224
+
<ahref="#headless-tool-plugins" class="anchor">
225
+
<h3>Headless Tool</h3>
226
+
</a>
227
+
<p>To use EditorConfig with one of these headless tools, you will need to install a plugin.</p>
<p>This project is greatly in need of feedback from other developers. We want to hear ideas about how to make this project better. Please use the <ahref="http://groups.google.com/group/editorconfig">mailing list</a> to send an email to the EditorConfig team (subscribe by shooting an email to <ahref="mailto:[email protected]">[email protected]</a>) and use the <ahref="https://github.com/editorconfig/editorconfig/issues">issue tracker</a> to submit bugs (but please take a look at the <ahref="https://github.com/editorconfig/editorconfig/wiki/FAQ">FAQ</a> first). Also feel free to <ahref="https://twitter.com/EditorConfig">tweet at us</a>.</p>
221
252
</section>
222
253
223
254
<sectionid="create-a-plugin">
224
-
<h3>Create an editor plugin</h3>
255
+
<ahref="#create-a-plugin" class="anchor">
256
+
<h3>Create an editor plugin</h3>
257
+
</a>
225
258
226
259
<p>
227
260
EditorConfig editor plugins must follow the <ahref="https://spec.editorconfig.org">specifications</a>. They can be developed with the help from one of the EditorConfig core libraries.
@@ -247,9 +280,11 @@ <h3>Create an editor plugin</h3>
247
280
</section>
248
281
249
282
<sectionid="contributors">
250
-
<h3>Main Contributors</h3>
283
+
<ahref="#contributors" class="anchor">
284
+
<h3>Main Contributors</h3>
285
+
</a>
251
286
252
-
<p>We have many awesome contributors contributing to the specification, core library, and plugins. For an up-to-date list, please see the <ahref="https://github.com/editorconfig/editorconfig/wiki/Board-Member">Board Members page</a> and the <ahref="https://docs.github.com/en/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors">contributor pages</a> of the <ahref="https://github.com/editorconfig/specification/graphs/contributors">specification</a>, <ahref="#core-libraries">core libraries</a>, and <ahref="#editor-plugins">plugins</a>.</p>
287
+
<p>We have many awesome contributors contributing to the specification, core library, and plugins. For an up-to-date list, please see the <ahref="https://github.com/editorconfig/editorconfig/wiki/Board-Member">Board Members page</a> and the <ahref="https://docs.github.com/en/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors">contributor pages</a> of the <ahref="https://github.com/editorconfig/specification/graphs/contributors">specification</a>, <ahref="#core-libraries">core libraries</a>, and <ahref="#download">plugins</a>.</p>
253
288
254
289
<p>
255
290
Most of of EditorConfig logos were drawn by <ahref="https://squirrelmuffins.com">Kat On</a> and <ahref="https://pittankopta.net/">Amon Keishima</a>. Website were mainly by <ahref="https://treyhunner.com">Trey Hunner</a> and <ahref="https://www.topbug.net">Hong Xu</a>.
0 commit comments