uShip HTML Style Guide

Table of Contents

1. Syntax
2. Attributes
3. Semantics
4. License

Syntax

• Use tab/4-spaces to indent elements

   <!-- bad -->
   <div>
     <p>This is wrong</p>
   </div>
  
   <!-- good -->
   <div>
       <p>This is right</p>
   </div>

• Use a new line for every block, list, or table element, and indent every such child element

   <!-- bad -->
   <blockquote><p>Space, the final frontier.</p></blockquote><ul><li>Moe<li>Larry<li>Curly</ul>
   <table><thead><tr><th scope="col">Income<th scope="col">Taxes<tbody><tr><td>$ 5.00</td><td>$ 4.50</td></table>
  
   <!-- good -->
   <blockquote>
       <p>Space, the final frontier.</p>
   </blockquote>
   <ul>
       <li>Moe</li>
       <li>Larry</li>
       <li>Curly</li>
   </ul>
   <table>
       <thead>
           <tr>
               <th scope="col">Income</th>
               <th scope="col">Taxes</th>
           </tr>
       </thead>
       <tbody>
           <tr>
               <td>$ 5.00</td>
               <td>$ 4.50</td>
           </tr>
       </tbody>
   </table>

• Use double quotations for attribute values

   <!-- bad -->
   <button id='nav-toggle' type='button'></button>
  
   <!-- good -->
   <button id="nav-toggle" type="button"></button>

• Omit type attributes for stylesheets and scripts

   <!-- bad -->
   <link rel="stylesheet" href="//www.google.com/css/maia.css" type="text/css">
   <script src="//www.google.com/js/gweb/analytics/autotrack.js" type="text/javascript"></script>
   
   <!-- good -->
   <link rel="stylesheet" href="//www.google.com/css/maia.css">
   <script src="//www.google.com/js/gweb/analytics/autotrack.js"></script>

• Use HTML according to its purpose. Use elements (sometimes incorrectly called “tags”) for what they have been created for. For example, use heading elements for headings, p elements for paragraphs, a elements for anchors, etc.

  Using HTML according to its purpose is important for accessibility, reuse, and code efficiency reasons.

   <!-- bad -->
   <div onclick="goToRecommendations();">All recommendations</div>
   
   <!-- good -->
   <a href="recommendations/">All recommendations</a>

Attributes

• Pay attention to element attribute order

  Order of basic attributes in element:

  id → class → data-bind

   <!-- bad -->
   <div data-bind="text: 'This Is Text'" class="test" id="test1"></div>
  
   <!-- good -->
   <div id="test1" class="test" data-bind="text: 'This Is Text'"></div>

Semantic Tags

    <!-- Supported Tags -->

    <header></header>

    <hgroup></hgroup>

    <main></main>

    <nav></nav>

    <section></section>

    <h*></h*>

    <p></p>

    <ul></ul>

    <ol></ol>
    
    <dd></dd>
    
    <strong></strong>

    <em></em>

    <labels></labels>

    <article></article>

    <aside></aside>

    <dialog></dialog>

    <figcaption></figcaption>

    <figure></figure>

    <footer></footer>

License

(The MIT License)

Copyright (c) 2014 uShip

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.