Skip to content

Commit 97422b6

Browse files
Fix code formatting of values by using <code> instead of <q> (#200)
Resolves #197
1 parent 6f31ba0 commit 97422b6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -114,19 +114,19 @@ <h4>Supported Properties</h4>
114114
</a>
115115
<p>Note that not all properties are supported by every plugin. The wiki has a <a href="https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties">complete list of properties</a>.</p>
116116
<ul class="property-definitions">
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>
118-
<li><dfn><code>indent_size</code></dfn>: a whole number defining the number of columns used for each indentation level and the width of soft tabs (when supported). When set to <q>tab</q>, the value of <strong><code>tab_width</code></strong> (if specified) will be used.</li>
117+
<li><dfn><code>indent_style</code></dfn>: set to <code>tab</code> or <code>space</code> to use hard tabs or soft tabs respectively.</li>
118+
<li><dfn><code>indent_size</code></dfn>: a whole number defining the number of columns used for each indentation level and the width of soft tabs (when supported). When set to <code>tab</code>, the value of <strong><code>tab_width</code></strong> (if specified) will be used.</li>
119119
<li><dfn><code>tab_width</code></dfn>: a whole number defining the number of columns used to represent a tab character. This defaults to the value of <strong><code>indent_size</code></strong> and doesn't usually need to be specified.</li>
120-
<li><dfn><code>end_of_line</code></dfn>: set to <q>lf</q>, <q>cr</q>, or <q>crlf</q> to control how line breaks are represented.</li>
121-
<li><dfn><code>charset</code></dfn>: set to <q>latin1</q>, <q>utf-8</q>, <q>utf-8-bom</q>, <q>utf-16be</q> or <q>utf-16le</q> to control the character set.</li>
122-
<li><dfn><code>trim_trailing_whitespace</code></dfn>: set to <q>true</q> to remove any whitespace characters preceding newline characters and <q>false</q> to ensure it doesn't.</li>
123-
<li><dfn><code>insert_final_newline</code></dfn>: set to <q>true</q> to ensure file ends with a newline when saving and <q>false</q> to ensure it doesn't.</li>
124-
<li><dfn><code>root</code></dfn>: special property that should be specified at the top of the file outside of any sections. Set to <q>true</q> to stop <code>.editorconfig</code> files search on current file.</li>
120+
<li><dfn><code>end_of_line</code></dfn>: set to <code>lf</code>, <code>cr</code>, or <code>crlf</code> to control how line breaks are represented.</li>
121+
<li><dfn><code>charset</code></dfn>: set to <code>latin1</code>, <code>utf-8</code>, <code>utf-8-bom</code>, <code>utf-16be</code> or <code>utf-16le</code> to control the character set.</li>
122+
<li><dfn><code>trim_trailing_whitespace</code></dfn>: set to <code>true</code> to remove any whitespace characters preceding newline characters and <code>false</code> to ensure it doesn't.</li>
123+
<li><dfn><code>insert_final_newline</code></dfn>: set to <code>true</code> to ensure file ends with a newline when saving and <code>false</code> to ensure it doesn't.</li>
124+
<li><dfn><code>root</code></dfn>: special property that should be specified at the top of the file outside of any sections. Set to <code>true</code> to stop <code>.editorconfig</code> files search on current file.</li>
125125
</ul>
126126

127-
<p>Currently all properties and values are case-insensitive. They are lowercased when parsed. Generally, if a property is not specified, the editor settings will be used, i.e. EditorConfig takes no effect on that part. For any property, a value of <q>unset</q> is to remove the effect of that property, even if it has been set before. For example, add <code>indent_size = unset</code> to undefine <strong><code>indent_size</code></strong> property (and use editor default).</p>
127+
<p>Currently all properties and values are case-insensitive. They are lowercased when parsed. Generally, if a property is not specified, the editor settings will be used, i.e. EditorConfig takes no effect on that part. For any property, a value of <code>unset</code> is to remove the effect of that property, even if it has been set before. For example, add <code>indent_size = unset</code> to undefine <strong><code>indent_size</code></strong> property (and use editor default).</p>
128128

129-
<p>It is acceptable and often preferred to leave certain EditorConfig properties unspecified. For example, <strong><code>tab_width</code></strong> need not be specified unless it differs from the value of <strong><code>indent_size</code></strong>. Also, when <strong><code>indent_style</code></strong> is set to <q>tab</q>, it may be desirable to leave <strong><code>indent_size</code></strong> unspecified so readers may view the file using their preferred indentation width. Additionally, if a property is not standardized in your project (<strong><code>end_of_line</code></strong> for example), it may be best to leave it blank.</p>
129+
<p>It is acceptable and often preferred to leave certain EditorConfig properties unspecified. For example, <strong><code>tab_width</code></strong> need not be specified unless it differs from the value of <strong><code>indent_size</code></strong>. Also, when <strong><code>indent_style</code></strong> is set to <code>tab</code>, it may be desirable to leave <strong><code>indent_size</code></strong> unspecified so readers may view the file using their preferred indentation width. Additionally, if a property is not standardized in your project (<strong><code>end_of_line</code></strong> for example), it may be best to leave it blank.</p>
130130

131131
</section>
132132

0 commit comments

Comments
 (0)