├── .gitignore ├── README.md ├── _config.yml ├── _includes ├── css │ ├── class-names.css │ ├── comments.css │ ├── declaration-order.css │ ├── import.html │ ├── media-queries.css │ ├── nesting.scss │ ├── organization-comments.css │ ├── organization-files.txt │ ├── prefixed-properties.css │ ├── selectors.css │ ├── shorthand.css │ ├── single-declarations.css │ └── syntax.css ├── footer.html ├── header.html ├── html │ ├── attribute-order.html │ ├── boolean-attributes.html │ ├── doctype.html │ ├── encoding.html │ ├── ie-compatibility-mode.html │ ├── lang.html │ ├── naming.html │ ├── reducing-markup.html │ ├── style-script.html │ └── syntax.html ├── js.html ├── syntax.css └── tweet-button.html ├── _layouts ├── default.html └── post.html ├── code-guide.css ├── font ├── fontello.eot ├── fontello.svg ├── fontello.ttf └── fontello.woff └── index.html /.gitignore: -------------------------------------------------------------------------------- 1 | # Ignore docs files 2 | _gh_pages 3 | _site 4 | .ruby-version 5 | 6 | # Numerous always-ignore extensions 7 | *.diff 8 | *.err 9 | *.orig 10 | *.log 11 | *.rej 12 | *.swo 13 | *.swp 14 | *.zip 15 | *.vi 16 | *~ 17 | 18 | # OS or Editor folders 19 | .DS_Store 20 | ._* 21 | Thumbs.db 22 | .cache 23 | .project 24 | .settings 25 | .tmproj 26 | *.esproj 27 | nbproject 28 | *.sublime-project 29 | *.sublime-workspace 30 | .idea 31 | 32 | # Komodo 33 | *.komodoproject 34 | .komodotools 35 | 36 | # grunt-html-validation 37 | validation-status.json 38 | validation-report.json 39 | 40 | # Folders to ignore 41 | node_modules 42 | bower_components 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Code Guide 2 | 3 | Code Guide is a project for documenting standards for developing flexible, durable, and sustainable HTML and CSS. It comes from years of experience writing code on projects of all sizes. It's not the end-all be-all, but it's a start. 4 | 5 | **[Start reading ☞](http://mdo.github.io/code-guide)** 6 | 7 | --- 8 | 9 | ### License 10 | 11 | Released under MIT by, and copyright 2014, @mdo. 12 | 13 | ### Thanks 14 | 15 | Heavily inspired by [Idiomatic CSS](https://github.com/necolas/idiomatic-css) and the [GitHub Styleguide](http://github.com/styleguide). 16 | 17 | ### Translations 18 | 19 | Translations are maintained by their creators and may not always be up to date with the original here. 20 | 21 | - [Portuguese](http://diegoeis.github.io/code-guide/) - Translated by [Diego Eis](http://tableless.com.br/) 22 | - [Spanish](http://adrianayala.mx/code-guide/es/) - Translated by [Adrian Ayala](http://adrianayala.mx/) 23 | - [Indonesian](http://diagramatics.github.io/code-guide-id) - Translated by [Steven Sinatra](http://diagramatics.me) 24 | - [Chinese](http://zoomzhao.github.io/code-guide/) - Translated by [Zoom Zhao](https://github.com/ZoomZhao) 25 | - [Italian](http://alessandro1997.github.io/code-guide/) - Translated by [Alessandro Desantis](https://github.com/alessandro1997) 26 | - [Russian](http://sadcitizen.github.io/code-guide/) - Translated by [Eugene Abrosimov](https://github.com/sadcitizen) 27 | 28 | Have a translation you'd like to link to? Open a pull request to add it. 29 | 30 | <3 31 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | name: Руководство по написанию кода от @mdo 2 | description: Стандарты для разработки гибкого, надежного и поддерживаемого кода на HTML и CSS. 3 | url: http://mdo.github.com/code-guide 4 | 5 | markdown: rdiscount 6 | permalink: pretty 7 | pygments: true 8 | -------------------------------------------------------------------------------- /_includes/css/class-names.css: -------------------------------------------------------------------------------- 1 | /* Плохой пример */ 2 | .t { ... } 3 | .red { ... } 4 | .header { ... } 5 | 6 | /* Хороший пример */ 7 | .tweet { ... } 8 | .important { ... } 9 | .tweet-header { ... } 10 | -------------------------------------------------------------------------------- /_includes/css/comments.css: -------------------------------------------------------------------------------- 1 | /* Плохой пример */ 2 | /* Modal header */ 3 | .modal-header { 4 | ... 5 | } 6 | 7 | /* Хороший пример */ 8 | /* Обертывающий элемент для .modal-title и .modal-close */ 9 | .modal-header { 10 | ... 11 | } 12 | -------------------------------------------------------------------------------- /_includes/css/declaration-order.css: -------------------------------------------------------------------------------- 1 | .declaration-order { 2 | /* Позиционирование */ 3 | position: absolute; 4 | top: 0; 5 | right: 0; 6 | bottom: 0; 7 | left: 0; 8 | z-index: 100; 9 | 10 | /* Блочная модель */ 11 | display: block; 12 | float: right; 13 | width: 100px; 14 | height: 100px; 15 | 16 | /* Типографика */ 17 | font: normal 13px "Helvetica Neue", sans-serif; 18 | line-height: 1.5; 19 | color: #333; 20 | text-align: center; 21 | 22 | /* Отображение */ 23 | background-color: #f5f5f5; 24 | border: 1px solid #e5e5e5; 25 | border-radius: 3px; 26 | 27 | /* Прочее */ 28 | opacity: 1; 29 | } 30 | -------------------------------------------------------------------------------- /_includes/css/import.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 8 | -------------------------------------------------------------------------------- /_includes/css/media-queries.css: -------------------------------------------------------------------------------- 1 | .element { ... } 2 | .element-avatar { ... } 3 | .element-selected { ... } 4 | 5 | @media (min-width: 480px) { 6 | .element { ...} 7 | .element-avatar { ... } 8 | .element-selected { ... } 9 | } 10 | -------------------------------------------------------------------------------- /_includes/css/nesting.scss: -------------------------------------------------------------------------------- 1 | // Без вложенности 2 | .table > thead > tr > th { … } 3 | .table > thead > tr > td { … } 4 | 5 | // С вложенностью 6 | .table > thead > tr { 7 | > th { … } 8 | > td { … } 9 | } 10 | -------------------------------------------------------------------------------- /_includes/css/organization-comments.css: -------------------------------------------------------------------------------- 1 | /* 2 | * Заголовок раздела для компонента 3 | */ 4 | 5 | .element { ... } 6 | 7 | 8 | /* 9 | * Заголовок раздела для компонента 10 | * 11 | * Иногда возникает необходимость включения дополнительного контекста для всего компонента. Сделайте это в этом месте, если это достаточно важно. 12 | */ 13 | 14 | .element { ... } 15 | 16 | /* Контекстный под-компонент или модификатор */ 17 | .element-heading { ... } 18 | -------------------------------------------------------------------------------- /_includes/css/organization-files.txt: -------------------------------------------------------------------------------- 1 | stylesheets/ 2 | ├── normalize.css 3 | ├── buttons.css 4 | ├── forms.css 5 | ├── grid.css 6 | ├── header.css 7 | ├── footer.css 8 | ├── pagination.css 9 | └── input-group.css 10 | -------------------------------------------------------------------------------- /_includes/css/prefixed-properties.css: -------------------------------------------------------------------------------- 1 | /* Свойства с префиксами */ 2 | .selector { 3 | -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15); 4 | box-shadow: 0 1px 2px rgba(0,0,0,.15); 5 | } 6 | -------------------------------------------------------------------------------- /_includes/css/selectors.css: -------------------------------------------------------------------------------- 1 | /* Плохой пример */ 2 | span { ... } 3 | .page-container #stream .stream-item .tweet .tweet-header .username { ... } 4 | .avatar { ... } 5 | 6 | /* Хороший пример */ 7 | .avatar { ... } 8 | .tweet-header .username { ... } 9 | .tweet .avatar { ... } 10 | -------------------------------------------------------------------------------- /_includes/css/shorthand.css: -------------------------------------------------------------------------------- 1 | /* Плохой пример */ 2 | .element { 3 | margin: 0 0 10px; 4 | background: red; 5 | background: url("image.jpg"); 6 | border-radius: 3px 3px 0 0; 7 | } 8 | 9 | /* Хороший пример */ 10 | .element { 11 | margin-bottom: 10px; 12 | background-color: red; 13 | background-image: url("image.jpg"); 14 | border-top-left-radius: 3px; 15 | border-top-right-radius: 3px; 16 | } 17 | -------------------------------------------------------------------------------- /_includes/css/single-declarations.css: -------------------------------------------------------------------------------- 1 | /* Одиночные объявления в одну строчку */ 2 | .span1 { width: 60px; } 3 | .span2 { width: 140px; } 4 | .span3 { width: 220px; } 5 | 6 | /* Несколько объявлений, по одному на каждую строчку */ 7 | .sprite { 8 | display: inline-block; 9 | width: 16px; 10 | height: 15px; 11 | background-image: url(../img/sprite.png); 12 | } 13 | .icon { background-position: 0 0; } 14 | .icon-home { background-position: 0 -20px; } 15 | .icon-account { background-position: 0 -40px; } 16 | -------------------------------------------------------------------------------- /_includes/css/syntax.css: -------------------------------------------------------------------------------- 1 | /* Плохой CSS */ 2 | .selector, .selector-secondary, .selector[type=text] { 3 | padding:15px; 4 | margin:0px 0px 15px; 5 | background-color:rgba(0, 0, 0, 0.5); 6 | box-shadow:0 1px 2px #CCC,inset 0 1px 0 #FFFFFF 7 | } 8 | 9 | /* Хороший CSS */ 10 | .selector, 11 | .selector-secondary, 12 | .selector[type="text"] { 13 | padding: 15px; 14 | margin: 0 0 15px; 15 | background-color: rgba(0,0,0,.5); 16 | box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff; 17 | } 18 | -------------------------------------------------------------------------------- /_includes/footer.html: -------------------------------------------------------------------------------- 1 | 23 | -------------------------------------------------------------------------------- /_includes/header.html: -------------------------------------------------------------------------------- 1 |
2 |
3 | ✍ 4 |

{{ site.name }}

5 |

{{ site.description }}

6 | 7 |

8 | 9 | 10 | 11 | 12 | 13 | 14 |

15 |
16 |
17 | -------------------------------------------------------------------------------- /_includes/html/attribute-order.html: -------------------------------------------------------------------------------- 1 | 2 | Какая-то ссылка 3 | 4 | 5 | 6 | 7 | ... 8 | -------------------------------------------------------------------------------- /_includes/html/boolean-attributes.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 8 | -------------------------------------------------------------------------------- /_includes/html/doctype.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /_includes/html/encoding.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /_includes/html/ie-compatibility-mode.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /_includes/html/lang.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | -------------------------------------------------------------------------------- /_includes/html/naming.html: -------------------------------------------------------------------------------- 1 | .element { 2 | ... 3 | } 4 | .element-title { 5 | ... 6 | } 7 | .element-button { 8 | ... 9 | } 10 | -------------------------------------------------------------------------------- /_includes/html/reducing-markup.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /_includes/html/style-script.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /_includes/html/syntax.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Заголовок страницы 5 | 6 | 7 | Company 8 |

Привет, мир!

9 | 10 | 11 | -------------------------------------------------------------------------------- /_includes/js.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /_includes/syntax.css: -------------------------------------------------------------------------------- 1 | .hll { background-color: #ffffcc } 2 | /*{ background: #f0f3f3; }*/ 3 | .c { color: #999; } /* Comment */ 4 | .err { color: #AA0000; background-color: #FFAAAA } /* Error */ 5 | .k { color: #006699; } /* Keyword */ 6 | .o { color: #555555 } /* Operator */ 7 | .cm { color: #999; } /* Comment.Multiline */ /* Edited to remove italics and make into comment */ 8 | .cp { color: #009999 } /* Comment.Preproc */ 9 | .c1 { color: #999; } /* Comment.Single */ 10 | .cs { color: #999; } /* Comment.Special */ 11 | .gd { background-color: #FFCCCC; border: 1px solid #CC0000 } /* Generic.Deleted */ 12 | .ge { font-style: italic } /* Generic.Emph */ 13 | .gr { color: #FF0000 } /* Generic.Error */ 14 | .gh { color: #003300; } /* Generic.Heading */ 15 | .gi { background-color: #CCFFCC; border: 1px solid #00CC00 } /* Generic.Inserted */ 16 | .go { color: #AAAAAA } /* Generic.Output */ 17 | .gp { color: #000099; } /* Generic.Prompt */ 18 | .gs { } /* Generic.Strong */ 19 | .gu { color: #003300; } /* Generic.Subheading */ 20 | .gt { color: #99CC66 } /* Generic.Traceback */ 21 | .kc { color: #006699; } /* Keyword.Constant */ 22 | .kd { color: #006699; } /* Keyword.Declaration */ 23 | .kn { color: #006699; } /* Keyword.Namespace */ 24 | .kp { color: #006699 } /* Keyword.Pseudo */ 25 | .kr { color: #006699; } /* Keyword.Reserved */ 26 | .kt { color: #007788; } /* Keyword.Type */ 27 | .m { color: #FF6600 } /* Literal.Number */ 28 | .s { color: #d44950 } /* Literal.String */ 29 | .na { color: #4f9fcf } /* Name.Attribute */ 30 | .nb { color: #336666 } /* Name.Builtin */ 31 | .nc { color: #00AA88; } /* Name.Class */ 32 | .no { color: #336600 } /* Name.Constant */ 33 | .nd { color: #9999FF } /* Name.Decorator */ 34 | .ni { color: #999999; } /* Name.Entity */ 35 | .ne { color: #CC0000; } /* Name.Exception */ 36 | .nf { color: #CC00FF } /* Name.Function */ 37 | .nl { color: #9999FF } /* Name.Label */ 38 | .nn { color: #00CCFF; } /* Name.Namespace */ 39 | .nt { color: #2f6f9f; } /* Name.Tag */ 40 | .nv { color: #003333 } /* Name.Variable */ 41 | .ow { color: #000000; } /* Operator.Word */ 42 | .w { color: #bbbbbb } /* Text.Whitespace */ 43 | .mf { color: #FF6600 } /* Literal.Number.Float */ 44 | .mh { color: #FF6600 } /* Literal.Number.Hex */ 45 | .mi { color: #FF6600 } /* Literal.Number.Integer */ 46 | .mo { color: #FF6600 } /* Literal.Number.Oct */ 47 | .sb { color: #CC3300 } /* Literal.String.Backtick */ 48 | .sc { color: #CC3300 } /* Literal.String.Char */ 49 | .sd { color: #CC3300; font-style: italic } /* Literal.String.Doc */ 50 | .s2 { color: #CC3300 } /* Literal.String.Double */ 51 | .se { color: #CC3300; } /* Literal.String.Escape */ 52 | .sh { color: #CC3300 } /* Literal.String.Heredoc */ 53 | .si { color: #AA0000 } /* Literal.String.Interpol */ 54 | .sx { color: #CC3300 } /* Literal.String.Other */ 55 | .sr { color: #33AAAA } /* Literal.String.Regex */ 56 | .s1 { color: #CC3300 } /* Literal.String.Single */ 57 | .ss { color: #FFCC33 } /* Literal.String.Symbol */ 58 | .bp { color: #336666 } /* Name.Builtin.Pseudo */ 59 | .vc { color: #003333 } /* Name.Variable.Class */ 60 | .vg { color: #003333 } /* Name.Variable.Global */ 61 | .vi { color: #003333 } /* Name.Variable.Instance */ 62 | .il { color: #FF6600 } /* Literal.Number.Integer.Long */ 63 | 64 | .css .o, 65 | .css .o + .nt, 66 | .css .nt + .nt { color: #999; } 67 | -------------------------------------------------------------------------------- /_includes/tweet-button.html: -------------------------------------------------------------------------------- 1 |
2 | Tweet 3 |
4 | -------------------------------------------------------------------------------- /_layouts/default.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | {{ site.name }} 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | {% include header.html %} 19 | 20 | {{ content }} 21 | 22 | {% include footer.html %} 23 | 24 | {% include js.html %} 25 | 26 | 27 | 28 | -------------------------------------------------------------------------------- /_layouts/post.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 | 5 | {{ content }} 6 | -------------------------------------------------------------------------------- /code-guide.css: -------------------------------------------------------------------------------- 1 | --- 2 | layout: nil 3 | --- 4 | 5 | 6 | /* 7 | * Fonts 8 | */ 9 | 10 | @font-face { 11 | font-family: 'fontello'; 12 | src: url('font/fontello.eot'); 13 | src: url('font/fontello.eot#iefix') format('embedded-opentype'), 14 | url('font/fontello.woff') format('woff'), 15 | url('font/fontello.ttf') format('truetype'), 16 | url('font/fontello.svg') format('svg'); 17 | font-weight: normal; 18 | font-style: normal; 19 | } 20 | 21 | [class^="icon-"]:before, [class*=" icon-"]:before { 22 | font-family: "fontello"; 23 | font-style: normal; 24 | font-weight: normal; 25 | speak: none; 26 | display: inline-block; 27 | text-decoration: inherit; 28 | width: 1em; 29 | margin-right: .2em; 30 | text-align: center; 31 | font-variant: normal; 32 | text-transform: none; 33 | } 34 | 35 | .icon-github-circled:before { content: '\e800'; } /* '' */ 36 | .icon-twitter:before { content: '\e801'; } /* '' */ 37 | 38 | 39 | /* 40 | * Scaffolding and type 41 | */ 42 | 43 | html { 44 | font-size: 16px; 45 | } 46 | @media (min-width: 48rem) { 47 | html { 48 | font-size: 20px; 49 | } 50 | } 51 | 52 | body { 53 | margin: 0; 54 | font: 1rem/1.5 "PT Sans", sans-serif; 55 | color: #5a5a5a; 56 | } 57 | 58 | a { 59 | color: #08c; 60 | text-decoration: none; 61 | } 62 | a:hover { 63 | text-decoration: underline; 64 | } 65 | 66 | h1, h2, h3, h4 { 67 | margin: 0 0 .5rem; 68 | font-weight: normal; 69 | line-height: 1; 70 | color: #2a2a2a; 71 | letter-spacing: -.05em; 72 | } 73 | h1 { font-size: 3rem; } 74 | h2 { font-size: 2.5rem; } 75 | h3 { font-size: 1.75rem; } 76 | h4 { font-size: 1.25rem } 77 | 78 | p { 79 | margin: 0 0 1rem; 80 | } 81 | .lead { 82 | font-size: 1.3rem; 83 | } 84 | 85 | blockquote { 86 | position: relative; 87 | margin: 0 1rem 1rem; 88 | font-style: italic; 89 | color: #7a7a7a; 90 | } 91 | blockquote p { 92 | margin-bottom: 0; 93 | } 94 | 95 | ul li { 96 | margin-bottom: .25rem; 97 | } 98 | 99 | /* Tighten up margin on last items */ 100 | p:last-child, 101 | ul:last-child, 102 | blockquote:last-child{ 103 | margin-bottom: 0; 104 | } 105 | 106 | 107 | 108 | /* 109 | * Code 110 | */ 111 | 112 | code, 113 | pre { 114 | font-family: "PT Mono", Menlo, "Courier New", monospace; 115 | font-size: 95%; 116 | } 117 | code { 118 | padding: 2px 4px; 119 | font-size: 85%; 120 | color: #d44950; 121 | background-color: #f7f7f9; 122 | border-radius: .2rem; 123 | } 124 | 125 | pre { 126 | display: block; 127 | margin: 0 0 1rem; 128 | line-height: 1.4; 129 | white-space: pre; 130 | white-space: pre-wrap; 131 | } 132 | pre code { 133 | padding: 0; 134 | color: inherit; 135 | background-color: transparent; 136 | border: 0; 137 | } 138 | .highlight { 139 | margin: 0; 140 | } 141 | .highlight pre { 142 | margin-bottom: 0; 143 | } 144 | .highlight + .highlight { 145 | margin-top: 1rem; 146 | } 147 | 148 | 149 | /* 150 | * The Grid 151 | */ 152 | 153 | .col { 154 | padding: 2rem 1rem; 155 | } 156 | .col p { 157 | max-width: 40rem; 158 | } 159 | .col + .col { 160 | border-top: 1px solid #dfe1e8; 161 | background-color: #f7f7f9; 162 | } 163 | @media (min-width: 38rem) { 164 | .col { 165 | padding: 2rem; 166 | } 167 | } 168 | @media (min-width: 48rem) { 169 | .section { 170 | display: table; 171 | width: 100%; 172 | table-layout: fixed; 173 | } 174 | .col { 175 | display: table-cell; 176 | padding: 3rem; 177 | vertical-align: top; 178 | } 179 | .col + .col { 180 | border-top: 0; 181 | } 182 | } 183 | 184 | 185 | /* 186 | * Masthead 187 | */ 188 | 189 | .masthead { 190 | padding: 3rem 1rem; 191 | color: rgba(255,255,255,.5); 192 | text-align: center; 193 | background-color: #2a3440; 194 | } 195 | .masthead h1 { 196 | color: #fff; 197 | margin-bottom: .25rem; 198 | } 199 | .masthead .icon { 200 | display: inline-block; 201 | font-size: 3rem; 202 | margin: 0 .5rem; 203 | } 204 | .masthead-links { 205 | font-size: 2rem; 206 | } 207 | .masthead-links a { 208 | color: rgba(255,255,255,.5); 209 | text-decoration: none; 210 | transition: all .15s linear; 211 | } 212 | .masthead-links a:hover { 213 | color: #fff; 214 | } 215 | 216 | @media (min-width: 38rem) { 217 | .masthead { 218 | padding-top: 4rem; 219 | padding-bottom: 4rem; 220 | } 221 | } 222 | 223 | 224 | /* 225 | * Sections 226 | */ 227 | 228 | .heading { 229 | padding: 2rem 1rem 1.5rem; 230 | background-color: #dfe1e8; 231 | } 232 | 233 | @media (min-width: 38rem) { 234 | .heading { 235 | padding: 3rem 3rem 2.5rem; 236 | } 237 | } 238 | 239 | .section { 240 | border-bottom: 1px solid #dfe1e8; 241 | } 242 | 243 | 244 | /* 245 | * Footer 246 | */ 247 | 248 | .footer { 249 | padding: 3rem 1rem; 250 | font-size: 90%; 251 | text-align: center; 252 | } 253 | .footer p { 254 | margin-bottom: .5rem; 255 | } 256 | 257 | .quick-links { 258 | list-style: none; 259 | margin-left: 0; 260 | } 261 | .quick-links li { 262 | display: inline; 263 | } 264 | 265 | 266 | /* 267 | * Syntax highlighting 268 | */ 269 | 270 | {% include syntax.css %} 271 | -------------------------------------------------------------------------------- /font/fontello.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sadcitizen/code-guide/604c816d51f9609b24e24d119da939f7baa8b1d0/font/fontello.eot -------------------------------------------------------------------------------- /font/fontello.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Copyright (C) 2014 by original authors @ fontello.com 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /font/fontello.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sadcitizen/code-guide/604c816d51f9609b24e24d119da939f7baa8b1d0/font/fontello.ttf -------------------------------------------------------------------------------- /font/fontello.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sadcitizen/code-guide/604c816d51f9609b24e24d119da939f7baa8b1d0/font/fontello.woff -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 | 5 | 6 |
7 |

Оглавление

8 |
9 |
10 |
11 |

HTML

12 | 25 |
26 |
27 |

CSS

28 | 42 |
43 |
44 | 45 | 46 |
47 |
48 |

Золотое правило

49 |

Строго соблюдайте предложенные здесь или свои собственные соглашения. Если вы нашли ошибку, будь она большая или маленькая, сразу сообщите об этом. Если у вас есть что дополнить или вы хотите принять участие в разработке этих соглашений, пожалуйста, создайте issue на GitHub.

50 |
51 |
52 |
53 |

Каждая строка кода должна казаться написанной только одним человеком, вне зависимости от количества разработчиков.

54 |
55 |
56 |
57 | 58 | 59 | 60 |
61 |

HTML

62 |
63 | 64 |
65 |
66 |

Синтаксис

67 | 74 |
75 |
76 | {% highlight html %}{% include html/syntax.html %}{% endhighlight %} 77 |
78 |
79 | 80 |
81 |
82 |

HTML5 doctype

83 |

Укажите в начале каждой вашей HTML-страницы этот тип документа. Это заставит браузер работать в режиме соответствия стандартам, что обеспечит единообразное отображение ваших страниц в разных браузерах.

84 |
85 |
86 | {% highlight html %}{% include html/doctype.html %}{% endhighlight %} 87 |
88 |
89 | 90 |
91 |
92 |

Атрибут языка

93 |

Из спецификации HTML5:

94 |
95 |

Для указания языка документа авторам рекомендуется прописывать атрибут языка в корневом элементе html. Это поможет инструментам синтеза речи определить какое произношение использовать, а инструментам перевода - какие правила, и так далее.

96 |
97 |

Подробнее познакомиться с атрибутом lang можно в спецификации.

98 |

Список кодов различных языков на Sitepoint.

99 |
100 |
101 | {% highlight html %}{% include html/lang.html %}{% endhighlight %} 102 |
103 |
104 | 105 |
106 |
107 |

Режим совместимости Internet Explorer

108 |

IE поддерживает использование специального <meta>-тега, который указывает в режиме совместимости с какой версией IE следует отрендерить страницу. Если обстоятельства не требуют какой-то специальной версии IE, то самым правильным будет заставить браузер использовать режим самой последней версии (edge mode).

109 |

Для получения дополнительной информации следует познакомиться со статьей на Stack Overflow.

110 |
111 |
112 | {% highlight html %}{% include html/ie-compatibility-mode.html %}{% endhighlight %} 113 |
114 |
115 | 116 |
117 |
118 |

Кодировка символов

119 |

Явно объявив кодировку символов, вы быстро и легко обеспечите правильное отображение вашего контента. При этом, вы сможете избежать использования символьных сущностей в вашем HTML-коде, при условии, что их кодировка совпадает с кодировкой документа (как правило, UTF-8).

120 |
121 |
122 | {% highlight html %}{% include html/encoding.html %}{% endhighlight %} 123 |
124 |
125 | 126 |
127 |
128 |

Подключение CSS и JavaScript

129 |

Согласно спецификации HTML5, при подключении CSS и JavaScript файлов не требуется указание атрибута type, так как text/css и text/javascript являются значениями по умолчанию.

130 |

Ссылки на спецификацию HTML5:

131 | 136 |
137 |
138 | {% highlight html %}{% include html/style-script.html %}{% endhighlight %} 139 |
140 |
141 | 142 |
143 |
144 |

Практичность важнее чистоты

145 |

Старайтесь соблюдать стандарты HTML и семантику, но не за счет практичности. Используйте меньшее количество разметки с наименьшим числом тонкостей, когда это возможно.

146 |
147 |
148 | 149 |
150 |
151 |

Порядок атрибутов

152 |

Для удобства чтения HTML-атрибуты должны быть указаны именно в этом порядке:

153 | 161 |

Классы создают для многократно используемых компонентов верстки, поэтому они идут первыми. Идентификаторы более специфичны и должны использоваться умеренно (например, для закладок на странице), поэтому они следуют вторыми.

162 |
163 |
164 | {% highlight html %}{% include html/attribute-order.html %}{% endhighlight %} 165 |
166 |
167 | 168 |
169 |
170 |

Логические атрибуты

171 |

Логические атрибуты одни из тех, которые не требуют объявленного значения. XHTML требует от вас задать значение, но в HTML5 нет такого требования.

172 |

За подробной информацией обратимся к разделу о логических атрибутах на WhatWG:

173 |
174 |

Наличие логического атрибута у элемента говорит об истинном его значении, а отсутствие атрибута — о ложном.

175 |
176 |

Если вы должны указать значение атрибута, но вам это не нужно, следуйте этой рекомендации от WhatWG:

177 |
178 |

Если атрибут присутствует, его значение должно быть либо пустой строкой или [...] каноническим именем атрибута без начальных или конечных пробелов.

179 |
180 |

Если коротко, то не указывайте значение логическому атрибуту.

181 |
182 |
183 | {% highlight html %}{% include html/boolean-attributes.html %}{% endhighlight %} 184 |
185 |
186 | 187 |
188 |
189 |

Сокращение разметки

190 |

Всякий раз, когда это возможно, избегайте лишних родительских элементов. Во многих случаях это требует повторения и рефакторинга, но позволяет создать меньшее количество разметки. Посмотрите на следующий пример:

191 |
192 |
193 | {% highlight html %}{% include html/reducing-markup.html %}{% endhighlight %} 194 |
195 |
196 | 197 |
198 |
199 |

Разметка, генерируемая с помощью JavaScript

200 |

Создание разметки с помощью JavaScript делает ее менее производительной, сложной для поиска и редактирования. По возможности избегайте этого.

201 |
202 |
203 | 204 | 205 | 206 |
207 |

CSS

208 |
209 | 210 |
211 |
212 |

Синтаксис

213 | 229 |

Есть вопросы по перечисленным соглашениям? Ознакомьтесь с разделом о синтаксисе статьи о каскадных таблицах стилей на Википедии.

230 |
231 |
232 | {% highlight css %}{% include css/syntax.css %}{% endhighlight %} 233 |
234 |
235 | 236 |
237 |
238 |

Порядок объявления

239 |

Объявления логически связанных свойств должны быть сгруппированы в следующем порядке:

240 |
    241 |
  1. Позиционирование
    2. 242 |
  2. Блочная модель
    3. 243 |
  3. Типографика
    4. 244 |
  4. Отображение
    5. 245 |
246 |

Позиционирование следует первым потому, что оно может удалить элемент из нормального потока документа и переопределить блочную модель связанных стилей. Блочная модель идет следующей, так как она диктует размеры и расположение компонента.

247 |

Все остальные объявления, выполняющиеся внутри компонента или не оказывающие влияния на предыдущие два раздела, следуют в последнюю очередь.

248 |

Для ознакомления с полным списком свойств и их порядком обратитесь к Recess.

249 |
250 |
251 | {% highlight css %}{% include css/declaration-order.css %}{% endhighlight %} 252 |
253 |
254 | 255 |
256 |
257 |

Не используйте @import

258 |

По сравнению с тегом <link> правило @import медленнее, создает дополнительные запросы и может вызвать иные непредвиденные проблемы. Избегайте это правило и используйте вместо него один из альтернативных подходов:

259 | 264 |

Для получения дополнительной информации следует познакомиться со статьей Стива Соудерса.

265 |
266 |
267 | {% highlight html %}{% include css/import.html %}{% endhighlight %} 268 |
269 |
270 | 271 |
272 |
273 |

Место для media query

274 |

Помещайте media queries настолько близко к соответствующим наборам правил, насколько это возможно. Не объединяйте их в отдельную таблицу стилей. Не помещайте их в конце файла. В противном случае это приведет к тому, что media queries будут не замечены в будущем. Вот типичная структура:

275 |
276 |
277 | {% highlight css %}{% include css/media-queries.css %}{% endhighlight %} 278 |
279 |
280 | 281 |
282 |
283 |

Свойства с префиксами

284 |

Когда вы используете свойства с префиксами вендоров, оставляйте отступы для каждого свойства так, чтобы значения объявлений выстраивались в вертикальную линию. Это упрощает многострочное редактирование.

285 |

В Textmate используйте Text → Edit Each Line in Selection (⌃⌘A). В Sublime Text 2, используйте Selection → Add Previous Line (⌃⇧↑) и Selection → Add Next Line (⌃⇧↓).

286 |
287 |
288 | {% highlight css %}{% include css/prefixed-properties.css %}{% endhighlight %} 289 |
290 |
291 | 292 |
293 |
294 |

Правила с одиночными объявлениями

295 |

В случаях, когда набор правил включает в себя только одно объявление, рекомендуется удалить переносы строк для удобства чтения и редактирования. Любой набор правил с несколькими объявлениями должен быть разделен на отдельные строки.

296 |

Ключевым фактором здесь является обнаружение ошибок — например, валидатор CSS сообщает вам, что в строке 183 есть синтаксическая ошибка. С одиночным объявлением не возникнет сложности с исправлением. В случае с несколькими объявлениями, разделенными на строки, так же проблем не возникнет. Но если несколько объявлений будут записаны в одну строку, то вам будет сложнее понять какое именно объявление вызвало синтаксическую ошибку.

297 |
298 |
299 | {% highlight css %}{% include css/single-declarations.css %}{% endhighlight %} 300 |
301 |
302 | 303 |
304 |
305 |

Сокращенная запись

306 |

Старайтесь ограничить использование сокращенных объявлений в тех случаях, когда необходимо явно задать все доступные значения. Наиболее часто злоупотребляют сокращением следующих свойств:

307 | 315 |

Часто нам не нужно устанавливать все значения сокращенной записи свойства. Например, HTML заголовки устанавливают только отступы сверху и снизу, таким образом, в случае необходимости нужно переопределить только эти два значения. Чрезмерное использование сокращенной записи свойств часто приводит к грязному коду с ненужными переопределения и непреднамеренными побочными эффектами.

316 |

На сайте Mozilla Developer Network есть отличная статья о сокращенной записи свойств для тех кто не знаком с такой формой записи.

317 |
318 |
319 | {% highlight css %}{% include css/shorthand.css %}{% endhighlight %} 320 |
321 |
322 | 323 |
324 |
325 |

Вложенность в Less и Sass

326 |

Избегайте излишнюю вложенность. То, что вы можете ее использовать, не означает, что вы всегда должны это делать. Применяйте вложенность только если вам нужно сократить область видимости стилей до родительского элемента, а также при наличии нескольких элементов, которые должны быть вложены.

327 |
328 |
329 | {% highlight scss %}{% include css/nesting.scss %}{% endhighlight %} 330 |
331 |
332 | 333 |
334 |
335 |

Комментарии

336 |

Код написан и поддерживается людьми. Убедитесь, что ваш код является описательным, хорошо прокомментирован и доступным (понятным) для других. Хорошие комментарии к коду передают контекст и цель кода, а не просто повторяют название класса или компонента.

337 |

Обязательно пишите законченные предложения для больших комментариев и короткие фразы для общих замечаний.

338 |
339 |
340 | {% highlight css %}{% include css/comments.css %}{% endhighlight %} 341 |
342 |
343 | 344 |
345 |
346 |

Имена классов

347 | 355 |

Также будет полезно использовать многие из приведенных рекомендаций для имен переменных в препроцессорах Sass и Less.

356 |
357 |
358 | {% highlight css %}{% include css/class-names.css %}{% endhighlight %} 359 |
360 |
361 | 362 |
363 |
364 |

Селекторы

365 | 371 |

Дополнительно к прочтению:

372 | 376 |
377 |
378 | {% highlight css %}{% include css/selectors.css %}{% endhighlight %} 379 |
380 |
381 | 382 |
383 |
384 |

Организация кода

385 | 391 |
392 |
393 | {% highlight css %}{% include css/organization-comments.css %}{% endhighlight %} 394 |
395 |
396 | 397 |
398 |
399 |

Настройки редактора кода

400 |

Установите в вашем редакторе следующие настройки, которые помогут избежать распространенных несогласованностей в коде и грязи:

401 | 407 |

Подумайте над документированием и применением этих настроек в файле .editorconfig вашего проекта. Для примера, ознакомьтесь с файлом настроек для Bootstrap. Узнайте больше об EditorConfig.

408 |
409 |
410 | --------------------------------------------------------------------------------