Working to coding guidelines

Now that we have a copy of the documentation installed locally, we're ready to start contributing! However, before we do so, there are some guidelines that are worth noting and it will help make the documentation consistent, readable, and maintainable. Let's take a brief look at these standards in more detail, beginning with markdown standards:

  • Use # for titles, not underlines. Underlines are not semantic, aren't as flexible, and aren't always highlighted properly in code highlighters.
  • Always add a space between # and the heading.
  • Wrap the inline code with a single backtick, or blocks of code with three backticks (code fences).
  • With code blocks, always use the correct language after the first code fence. Although GitHub ...

Get Learning Less.js now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.