Style Guide

URL

Given title:

The W3C device orientation API: detecting orientation and acceleration

Bad URL:

the-w3c-device-orientation-api-detecting-orientation-and-acceleration

Good URL:

w3c-device-orientation

Header

Every header on a page will get id generated from its content:

# W3C device orientation API
…
<h1 id="w3c-device-orientation-api">W3C device orientation API</h1>

It's good enough for simple headers like “Read more” or “Introduction”, but if your header contains more than 3-5 words and you're going to use it, it's better to specify custom id by adding {#id}:

# W3C device orientation API {#w3c-api}
…
<h1 id="w3c-api">W3C device orientation API</h1>

Code

Quote

Note

Picture

If you want to add picture with description, use <figure> element below:

<figure id="figure-1">
    <img src="filename.jpg" alt="">
    <figcaption markdown="span">Figure 1: Description</figcaption>
</figure>

To be able to use Markdown inside <figcaption> make sure there's markdown="span" attribute.