Book Image

Learning less.js

Book Image

Learning less.js

Overview of this book

Table of Contents (22 chapters)
Learning Less.js
Credits
About the Author
About the Reviewers
www.PacktPub.com
Preface
Index

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 does not highlight Less, our documentation is more likely to show up in GitHub's and Google's search results when the correct language is used. For example, use ```less for Less and ```css for CSS.

A similar set of guidelines exist for maintaining...