{"componentChunkName":"component---src-templates-post-js","path":"/blog/2019/09/03/html-best-practices/","result":{"data":{"post":{"html":"

How often have you wrote a block of HTML without realising the code you’ve written might not be ideal?

\n\n

The why

\n

HTML has always been that kid in the corner where nobody talks to because JavaScript and CSS have always stolen the attention.

\n

Now keep that picture in your mind cause I am going to go through some simple tips which together, make a difference and help bring that kid in the centre again 😁.

\n

These are part of a perspective of creating a clean, maintainable and scalable code, that will make a good use of the semantic markup elements of HTML5 and that will render correctly in supported browsers.

\n

So just to stop me from going on and on about why, let’s have a look at the what.

\n

DOCTYPE

\n

Starting from the top of your index.html, make sure you’re declaring a DOCTYPE. This will activate the standard mode in all browsers and let them know how the document should be interpreted. Keep in mind that DOCTYPE is not an HTML element.

\n

For HTML5 it looks like:

\n`, `94764186388581730000`)\"\n >\n \n Copy\n \n \n
<!DOCTYPE html>
\n

Note: If you’re using a framework, this is prepopulated for you. If not, I highly recommend using code snippets like Emmet which is available in VS Code.

\n

\"Emmet

\n

Curious to find out more about other doc types? Have a look at this reference document.

\n

Optional tags

\n

Some tags are optional in HTML5, mostly because the element is implicitly present. Believe it or not, you can omit the <html> tag and the page will render just fine.

\n\r\n\r\n \r\n Hello\r\n \r\n \r\n

Welcome to this example.

\r\n \r\n`, `29745365217540653000`)\"\n >\n \n Copy\n \n \n
<!DOCTYPE HTML>\r\n\r\n  <head>\r\n    <title>Hello</title>\r\n  </head>\r\n  <body>\r\n    <p>Welcome to this example.</p>\r\n  </body>\r\n</html>
\n

Above is a valid HTML, however, there are some cases where you can’t do so, such as tags followed by comments:

\n\r\n\r\n\r\n \r\n Hello\r\n \r\n \r\n

Welcome to this example.

\r\n \r\n`, `61590887748968080000`)\"\n >\n \n Copy\n \n \n
<!DOCTYPE HTML>\r\n<!-- where is this comment in the DOM? -->\r\n\r\n  <head>\r\n    <title>Hello</title>\r\n  </head>\r\n  <body>\r\n    <p>Welcome to this example.</p>\r\n  </body>\r\n</html>
\n

Above is invalid because the parse tree changes due to comment being outside of <html> tag.

\n

Closing tags

\n

You should always consider closing your tags because some browsers will have trouble rendering your page. However, it’s recommended to keep those for readability and other reasons which I will go through later.

\n\r\n "example"\r\n example\r\n

example

\r\n`, `37988837845101320000`)\"\n >\n \n Copy\n \n \n
<div id=\"example\">\r\n  <img src=\"example.jpg\" alt=\"example\" />\r\n  <a href=\"#\" title=\"test\">example</a>\r\n  <p>example</p>\r\n</div>
\n

Above are all valid tags. But there are also some exceptions 👇🏼 to this rule.

\n

Self-closing tags are valid, but not required. These elements include:

\n,
, , , , ,\r\n, , , , , , , , , `, `79025342624319080000`)\"\n >\n \n Copy\n \n \n
<br>, <hr>, <img>, <input>, <link>, <meta>,\r\n<area>, <base>, <col>, <command>, <embed>, <keygen>, <param>, <source>, <track>, <wbr>
\n

Note: Normal elements can never have self-closing tags.

\n`, `49995217702753124000`)\"\n >\n \n Copy\n \n \n
<title />
\n

Above is invalid obviously.

\n

Charset

\n

Define your character set upfront. It is best practice to put it right on top inside <head> element.

\n\r\n This is a super duper cool title, right 😥?\r\n \r\n`, `71584808963843470000`)\"\n >\n \n Copy\n \n \n
<head>\r\n  <title>This is a super duper cool title, right 😥?</title>\r\n  <meta charset=\"utf-8\">\r\n</head>
\n

Above is invalid and title wouldn’t render properly. Instead move the character set deceleration on top.

\n\r\n \r\n This is a super duper cool title, right 😃? \r\n`, `87567367058600740000`)\"\n >\n \n Copy\n \n \n
<head>\r\n  <meta charset=\"utf-8\">\r\n  <title>This is a super duper cool title, right 😃?</title>  \r\n</head>
\n

Language

\n

Another reason to not omit the optional tags is when using attributes. In this case you can and you should define the language of your web page. This is really important for accessibility and searching.

\n\r\n ...\r\n`, `87370258978471890000`)\"\n >\n \n Copy\n \n \n
<html lang=\"fr-CA\">\r\n  ...\r\n</html>
\n

Title

\n

Never, never, ever omit the title tag. It’s super bad for accessibility, and I will personally never use your site because I can’t find it 2 seconds after opening it and 20 more tabs later 😁 (the browser tab won’t have anything to show).

\n

The base tag

\n

This is a really useful tag which should be used with cautious. This will set the base URL for the app. Once set, all links will be relative to this base URL, which might cause some unwanted behaviour:

\n`, `82321321089848280000`)\"\n >\n \n Copy\n \n \n
<base href=\"http://www.example.com/\" />
\n

With above set, href=\"#internal\" will be interpreted as href=\"http://www.example.com/#internal\".

\n

Or href=\"example.org\" will be interpreted as href=\"http://www.example.com/example.org\".

\n

Description

\n

This meta tag is very useful although it’s not strictly part of best practices. This is super useful for search engines when they crawl your site.

\n`, `86216018425035520000`)\"\n >\n \n Copy\n \n \n
<meta name=\"description\" content=\"HTML best practices\">
\n

I have a post you can check on SEO which has been super popular.

\n

Semantic tags

\n

Although you can create your UX engineer’s wire frames with just divs, it doesn’t mean you should. Semantic HTML gives meaning to your page rather than just presentations. Tags like p, section, h{1-6}, main, nav, etc are all semantic tags. If you use a p tag, users will know this represents a paragraph of text and browsers know how to represent them.

\n

On the other hand, tags like i and b do not represent semantics. They just try to define how the text should look like. Semantic HTML is way beyond the scope of this article. But you should defo check them out and use them as if they’re your pen when you’re writing. Can you write without a pen ❓ (or mouse 😁)?

\n

hr shouldn’t be used for formatting

\n

<hr> is not a formatting element, so stop using it to format your content. In HTML5 this tag represents a thematic break of your content. A proper use of it might look like this:

\nParagraph about puppies

\r\n

Paragraph about puppies' favourite foods

\r\n

Paragraph about puppies' breeds

\r\n
\r\n

Paragraph about why I am shaving my head 😂

`, `77930281010227170000`)\"\n >\n \n Copy\n \n \n
<p>Paragraph about puppies</p>\r\n<p>Paragraph about puppies' favourite foods</p>\r\n<p>Paragraph about puppies' breeds</p>\r\n<hr>\r\n<p>Paragraph about why I am shaving my head 😂</p>
\n

Be careful when you use the title attribute

\n

The title attribute is a powerful tool which can help clarify an action or the purpose of an element on the page like a tooltip. However, it’s not interchangeable with other attributes like alt on an image.

\n

From the HTML5 spec:

\n
\n

Relying on the title attribute is currently discouraged as many user agents do not expose the attribute in an accessible manner as required by this specification (e.g., requiring a pointing device such as a mouse to cause a tooltip to appear, which excludes keyboard-only users and touch-only users, such as anyone with a modern phone or tablet).

\n
\n

Read more about how to properly use this attribute.

\n

Single or double quotes

\n

I’ve faced many code bases where there are a mix of both in the markup. This is not good especially if you are using a framework which depends on single quote like php and also when you're using a single quote in a sentence just like I did now. Another reason is to keep it consistent which is always good. Don’t do:

\n`, `19058754108244914000`)\"\n >\n \n Copy\n \n \n
<img alt=\"super funny meme\" src='/img/meme.jpg'>
\n

Instead:

\n`, `44410103884521400000`)\"\n >\n \n Copy\n \n \n
<img alt=\"super funny meme\" src=\"/img/meme.jpg\">
\n

Omit boolean values

\n

When it comes to having boolean values for attributes, it’s recommended to omit those as they don’t add any value and also increase your markup’s weight.

\n\r\n\r\n\r\n\r\n