forked from htmlacademy/codeguide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
html-css.html
572 lines (526 loc) · 30.3 KB
/
html-css.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
<!DOCTYPE html>
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Стиль кода Академии HTML</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@htmlacademy_ru">
<meta name="twitter:image" content="https://htmlacademy.github.io/codeguide/img/og.png">
<meta property="og:type" content="website">
<meta property="og:url" content="https://htmlacademy.github.io/codeguide/">
<meta property="og:title" itemprop="name" content="Стиль кода Академии HTML">
<meta property="og:image" itemprop="image" content="https://htmlacademy.github.io/codeguide/img/og.png">
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/prism.css">
<link rel="stylesheet" href="css/style.css">
<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create','UA-29640059-7','auto');ga('send','pageview');</script>
</head>
<body>
<header>
<a href="https://htmlacademy.ru" target="_blank">
<img class="logo" src="img/bane.svg" width="300" height="300" alt="HTML Academy" title="HTML Academy">
</a>
<h1>Стиль кода Академии HTML</h1>
<p><a href="https://github.com/htmlacademy/codeguide">github.com/htmlacademy/codeguide</a></p>
</header>
<main>
<section class="chapter">
<h2>Оглавление</h2>
<article class="chapter-part">
<div class="chapter-part-col">
<h3>HTML</h3>
<ul>
<li><a href="#html-syntax">Синтаксис</a></li>
<li><a href="#html-validator">Валидность</a></li>
<li><a href="#html-doctype">HTML-доктайп</a></li>
<li><a href="#html-encoding">Кодировка символов</a></li>
<li><a href="#html-style-includes">Подключение стилей</a></li>
<li><a href="#html-js-includes">Подключение скриптов</a></li>
<li><a href="#html-attribute-order">Порядок атрибутов</a></li>
<li><a href="#html-boolean">Логические атрибуты</a></li>
<li><a href="#html-form-labels">Подписи полей ввода</a></li>
<li><a href="#html-img-sizes">Размеры картинок</a></li>
<li><a href="#html-language">Атрибут языка</a></li>
</ul>
</div>
<div class="chapter-part-col">
<h3>CSS</h3>
<ul>
<li><a href="#css-syntax">Синтаксис</a></li>
<li><a href="#css-order">Порядок свойств</a></li>
<li><a href="#css-class-names">Имена классов</a></li>
<li><a href="#css-import">Правило @import</a></li>
<li><a href="#css-font-variant">Варианты шрифта</a></li>
</ul>
</div>
</article>
</section>
<section class="chapter">
<h2>HTML</h2>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-syntax">Синтаксис</h3>
<ul>
<li>Для отступов у вложенных элементов используются два пробела. Для правильного форматирования используйте файл <a href="https://github.com/htmlacademy/codeguide/blob/master/.editorconfig" target="_blank">.editorconfig</a> в вашем редакторе.</li>
<li>Теги и их атрибуты пишутся строчными буквами. Для значений атрибутов всегда используются двойные кавычки.</li>
<li>Необязательный закрывающий слеш у одиночных тегов (<code><img></code>, <code><br></code> и другие) не ставится.</li>
<li>Необязательные закрывающие теги (например, <code></li></code> или <code></body></code>) не пропускаются.</li>
<li>Для проверки HTML-кода используйте файл конфигурации <a href="https://github.com/htmlacademy/codeguide/blob/master/.htmlhintrc" target="_blank">.htmlhintrc</a> для настройки валидатора <a href="http://htmlhint.com" target="_blank">HTMLHint</a>.</li>
</ul>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!DOCTYPE html>
<html lang="ru">
<head>
<meta charset="utf-8">
<title>Страница о коте</title>
</head>
<body>
<article class="post">
<h1>Красивый кот</h1>
<figure class="post-item">
<img src="cat.jpg" alt="Изображение кота">
<figcaption>Кот красив!</figcaption>
</figure>
</article>
</body>
</html></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-validator">Валидность</h3>
<p>
Документ должен проходить проверку на валидность. Для проверки используется <a href="http://validator.w3.org/nu/" target="_blank">современный валидатор</a>.
</p>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-doctype">HTML-доктайп</h3>
<p>
В начале страницы обязательно должен быть указан актуальный <code>doctype</code>, чтобы браузер отображал её в режиме соответствия стандартам. Это гарантирует, что страница будет выглядеть единообразно во всех современных браузерах.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!DOCTYPE html>
<html lang="ru">
<head>…</head>
<body>…</body>
</html></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-encoding">Кодировка символов</h3>
<p>
Кодировка символов на странице всегда должна быть явно указана, чтобы обеспечить корректное отображение текста. Кодировка <code>utf-8</code> предпочтительна.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><head>
<meta charset="utf-8">
<title>Заголовок страницы</title>
</head></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-style-includes">Подключение стилей</h3>
<p>
Стилевые файлы с помощью <code><link></code> подключаются внутри <code><head></code>. При этом атрибут <code>type</code> для тега <code><link></code> не указывается, так как его значение <code>text/css</code> устанавливается по умолчанию.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!-- Хорошо: стилевой файл подключён в секции head -->
<!DOCTYPE html>
<html lang="ru">
<head>
<link rel="stylesheet" href="style.css">
</head>
<body>…</body>
</html>
<!-- Плохо: стилевой файл подключён в секции body -->
<!DOCTYPE html>
<html lang="ru">
<head>…</head>
<body>
<link rel="stylesheet" href="style.css">
</body>
</html></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-js-includes">Подключение скриптов</h3>
<p>
Скрипты должны подключаться в самом низу страницы, чтобы при её загрузке не блокировать отображение содержимого.
</p>
<p>
При подключении скриптов в теге <code><script></code> атрибут <code>type</code> не указывается, так как его значение <code>text/javascript</code> устанавливается по умолчанию.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!-- Хорошо: скрипт подключается перед </body> -->
<!DOCTYPE html>
<html lang="ru">
<head>…</head>
<body>
<!-- Содержимое страницы -->
<script src="app.js"></script>
</body>
</html>
<!-- Плохо: скрипт подключается в секции <head> -->
<!DOCTYPE html>
<html lang="ru">
<head>
<script src="app.js"></script>
</head>
<body>…</body>
</html></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-attribute-order">Порядок атрибутов</h3>
<p>
Атрибут класса у HTML-элементов пишется первым. Единообразное написание помогает легче считывать код и быстрее разбираться в назначении блоков по их классам.
</p>
<p>
Остальные атрибуты могут быть расставлены в любом порядке, но тоже единообразно для одинаковых элементов.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><a class="element element-big" id="element" href="/" data-name="element">Ссылка</a>
<input class="form-control" type="text" name="test">
<img class="pets-picture" src="cats.jpg" alt="Изображение котиков"></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-boolean">Логические атрибуты</h3>
<p>
Для логических атрибутов (например, <code>checked</code>, <code>disabled</code>, <code>required</code>) значение не указывается, а сами атрибуты указываются последними и в единообразной последовательности во всём документе.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!-- checked="checked" необязательно -->
<input type="checkbox" required checked>
<input type="text" disabled>
<select>
<option value="1" selected>1</option>
</select></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-form-labels">Подписи полей ввода</h3>
<p>
Для улучшения взаимодействия пользователя с элементами форм, при нажатии на подпись поля, оно должно активироваться. Для этого элемент формы связывается с его описанием с помощью идентификатора и атрибута <code>for</code> тега <code><label></code>.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!-- Хорошо: элемент формы radio связан с подписью через идентификатор -->
<input type="radio" id="choose">
<label for="choose">Радио кнопка</label>
<!-- Хорошо: элемент формы radio и подпись обёрнуты в label -->
<label>
<input type="radio"> Радио кнопка
</label>
<!-- Плохо: подпись не связана с элементом формы -->
<input type="radio" id="choose"> Радио кнопка</code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-img-sizes">Размеры картинок</h3>
<p>
Изображениям <code><img></code> должны быть явно заданы с помощью атрибута размеры в пикселях. В случае пикселей размерность не нужна.
</p>
<p>
По возможности изображениям указываются действительные размеры, так как это улучшает производительность отрисовки страницы: браузер не будет перерисовывать страницу в процессе загрузки и отображения изображения.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!-- Хорошо: размеры картинке заданы -->
<div class="logo-area">
<img src="logo.png" alt="" width="300" height="150">
</div>
<!-- Плохо: размеры картинке заданы в px -->
<div class="logo-area">
<img src="logo.png" alt="" width="300px" height="150px">
</div>
<!-- Плохо: размеры картинке не заданы -->
<div class="logo-area">
<img src="logo.png" alt="">
</div></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="html-language">Атрибут языка</h3>
<p>
Для элемента <code><html></code> в атрибуте <code>lang</code> должен указываться соответствующий язык документа. Это помогает инструментам синтеза речи определить, какое использовать произношение или системам перевода, какие использовать языковые правила.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!DOCTYPE html>
<html lang="ru">
<head>…</head>
<body>…</body>
</html></code></pre>
</figure>
</div>
</article>
</section>
<section class="chapter">
<h2>CSS</h2>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="css-syntax">Синтаксис</h3>
<ul>
<li>После значения свойства обязательно ставится точка с запятой.</li>
<li>Для отступов внутри правил используются два пробела. Для правильного форматирования используйте файл <a href="https://github.com/htmlacademy/codeguide/blob/master/.editorconfig" target="_blank">.editorconfig</a> в вашем редакторе.</li>
<li>Шестнадцатеричное значение цвета не сокращается, а пишется полностью из всех шести символов. Для записи используются строчные буквы. Например, <code>#f5f5f5</code>.</li>
<li>Названия тегов и свойств в правилах пишутся строчными буквами.</li>
<li>Начальный ноль для значений не сокращается (например, <code>.5</code> вместо <code>0.5</code>).</li>
<li>Во всех случаях в стилях используются двойные кавычки. В необязательных случаях кавычки не опускаются.</li>
<li>После двоеточия в правилах ставится один пробел (<code>top: 10px;</code>). А перед двоеточием пробел не нужен.</li>
<li>После запятых внутри значений <code>rgb()</code>, <code>rgba()</code>, <code>hsl()</code>, <code>hsla()</code> или <code>rect()</code> пробелы ставятся. Это повышает удобочитаемость.</li>
<li>До и после комбинатора между селекторами (например, <code>p > a</code>) ставится один пробел.</li>
<li>Каждое объявление в правиле пишется на новой строке.</li>
<li>Перед открывающейся фигурной скобкой ставится один пробел. После скобки запись идёт с новой строки:
<pre class="language-css"><code>.selector {
color: #f5f5f5;
}
</code></pre></li>
<li>Закрывающая фигурная скобка пишется на новой строке и без отступа. Следующее после этого правило отделяется пустой строкой.</li>
<li>Единицы измерения не пишутся, там где в них нет необходимости. Например, <code>border: 0</code>.</li>
<li>Для проверки CSS-кода используйте <a href="https://github.com/htmlacademy/stylelint-config-htmlacademy" target="_blank">конфигурацию</a> для настройки валидатора <a href="http://stylelint.io" target="_blank">stylelint</a>.</li>
<li>Для автоматического применения этих правил используйте файл конфигурации <a href="https://github.com/htmlacademy/codeguide/blob/master/csscomb.json" target="_blank">csscomb.json</a> для настройки <a href="https://github.com/csscomb/csscomb.js" target="_blank">CSSComb</a>.</li>
</ul>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-css">/* Хорошо */
.selector,
.selector-secondary,
.selector[type="text"] {
padding: 15px;
margin-bottom: 15px;
background-color: rgba(0, 0, 0, 0.5);
box-shadow: 0 1px 2px #cccccc, inset 0 1px 0 #ffffff;
}
/* Плохо */
.selector, .selector-secondary, .selector[type=text]{
padding:15px;
margin:0px 0px 15px;
background-color:rgba(0,0,0,.5);
box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF}</code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="css-order">Порядок свойств</h3>
<p>
Объявления логически связанных свойств группируются в следующем порядке:
</p>
<ol>
<li>Позиционирование</li>
<li>Блочная модель</li>
<li>Типографика</li>
<li>Оформление</li>
<li>Анимация</li>
<li>Разное</li>
</ol>
<p>
Позиционирование следует первым потому, что оно влияет на положение блоков в потоке документа. Блочная модель идёт следующей, так как она определяет размеры и расположение блоков.
</p>
<p>
Все остальные объявления, которые изменяют вид внутренних частей блоков и не оказывают влияния на другие блоки, идут в последнюю очередь.
</p>
<p>
Сгруппированные объявления в правиле отделяются друг от друга пустой строкой.
</p>
<p>
Порядок объявления подробных правил, таких как <code>font-size</code>, <code>font-family</code>, <code>line-height</code>, должен соответствовать порядку в сокращённой версии правила. В случае совместного использования подробных и сокращённых правил, первой должна идти сокращённая версия.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-css">.declaration-order {
/* Позиционирование */
position: absolute;
top: 0;
right: 0;
bottom: 0;
left: 0;
z-index: 100;
/* Блочная модель */
display: block;
float: right;
width: 100px;
height: 100px;
margin: 10px;
padding: 10px;
/* Типографика */
font: normal 13px/1.5 "Arial", sans-serif;
font-style: normal;
font-size: 13px;
line-height: 1.5;
font-family: "Arial", sans-serif;
text-align: center;
color: #333333;
/* Оформление */
background-color: #f5f5f5;
border: 1px solid #e5e5e5;
border-radius: 3px;
opacity: 1;
/* Анимация */
transition: color 1s;
/* Разное */
will-change: auto;
}</code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="css-class-names">Имена классов</h3>
<ul>
<li>Имена классов пишутся строчными буквами, используется дефис (но не знаки нижнего подчёркивания или camelCase). Дефисы служат разделителями во взаимосвязанных классах (например, <code>.button</code> и <code>.button-danger</code>).</li>
<li>Имена классов должны быть такими, чтобы по ним можно было быстро понять какому элементу страницы задан класс: избегайте сокращений (единственное исключение — <code>.btn</code> для кнопок), но не делайте их слишком длинными (более трёх слов).</li>
<li>Для написания классов используются английские слова и термины. Транслитом названия классов и атрибутов не пишутся.</li>
</ul>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-css">/* Хорошо */
.alert-danger { … }
.tweet .user-picture { … }
.button { … }
.layout-center { … }
/* Плохо */
.testElement { … }
.t { … }
.big_red_button { … }
.knopka { … }</code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="css-import">Правило <code>@import</code></h3>
<p>
Правило <code>@import</code> работает медленнее, чем тег <code><link></code>. В стилях <code>@import</code> не должен использоваться.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-markup"><!-- Хорошо: подключение тегом link -->
<link rel="stylesheet" href="module.css">
<!-- Плохо -->
<style>
@import url("module.css");
</style></code></pre>
</figure>
</div>
</article>
<article class="chapter-part">
<div class="chapter-part-col">
<h3 id="css-font-variant">Варианты шрифта</h3>
<p>
Альтернативные варианты шрифта и тип семейства указываются в конце перечисления <code>font-family</code>.
</p>
<p>
В случае использования нестандартных шрифтов альтернативный веб-безопасный шрифт и тип семейства указываются, чтобы в случае отсутствия нестандартного шрифта в системе, изменения внешнего вида страницы были минимальны. Альтернативный шрифт должен быть такого же типа, что и нестандартный.
</p>
<p>
Порядок шрифтов следующий:
</p>
<ol>
<li>нестандартный шрифт;</li>
<li>веб-безопасный;</li>
<li>тип шрифта.</li>
</ol>
<p>
Список веб-безопасных шрифтов можно посмотреть здесь — <a href="http://www.cssfontstack.com" target="_blank">cssfontstack.com</a>.
</p>
</div>
<div class="chapter-part-col gray-bgcolor">
<figure>
<pre><code class="language-css">/* Хорошо: указан альтернативный веб-безопасный шрифт и его тип семейства */
body {
font-family: "Helvetica", "Arial", sans-serif;
}
/* Кому-то нравится Arial, кому-то Tahoma */
body {
font-family: "Helvetica", "Tahoma", sans-serif;
}
/* Плохо: указан только нестандартный шрифт */
body {
font-family: "Helvetica";
}
/* Плохо: указан только нестандартный шрифт и тип семейства, альтернативный веб-безопасный шрифт отсутствует */
body {
font-family: "Helvetica", sans-serif;
}
/* Плохо: Georgia — шрифт с засечками, а нестандартный шрифт — без засечек */
body {
font-family: "Helvetica", "Georgia", sans-serif;
}</code></pre>
</figure>
</div>
</article>
</section>
</main>
<footer>
<div class="contacts">
<a class="logo-full" href="https://htmlacademy.ru">
<img src="img/logo-full.svg" width="161" height="55" alt="HTML Academy" title="HTML Academy">
</a>
<div class="social-icons">
<a class="icon icon-vk" href="https://vk.com/htmlacademy" target="_blank">
Вконтакте
</a>
<a class="icon icon-fb" href="https://www.facebook.com/htmlacademy" target="_blank">
Facebook
</a>
<a class="icon icon-tw" href="https://twitter.com/htmlacademy_ru" target="_blank">
Twitter
</a>
<a class="icon icon-ig" href="https://instagram.com/htmlacademy" target="_blank">
Instagram
</a>
</div>
<div class="github">
<a class="github-link" href="https://github.com/htmlacademy" target="_blank">
GitHub
</a>
</div>
</div>
</footer>
<script src="js/prism.js"></script>
</body>
</html>