Simple CSS Logo

Simplicity CSS Documentation Conventions

The documentation for Simplicity CSS follows the conventions laid out in this document to help ensure that the documentation is consistent.

Descriptions

Each section of the documentation contains a description of it's covered section at the top of the document. While it is not guaranteed that all text will be placed at the top of the page, all necessary information will be at the top. More in-depth descriptions of specific items may appear lower on the document.

Class Names

When class names are specified in the documentation, they will appear in yellow text with a leading "." to make clear that the word or phrase is a CSS class. For example, if I were referencing the CSS class "thing", it would be seen as .thing in the documentation.

The leading "." does not imply that you should place the "." in the class list when adding classes to elements. It's purely informational and present to provide additional context in case someone who is reading the documentation is unable to differenatiate between the normal text color and the yellow text color.

For example, if you were to use the previously mentioned .thing class on a div in your HTML, it would look like this.

        <div class="thing">
            <!-- content -->
        </div>
    

Examples

Examples (both code and content) should be displayed on each page following the description. Where applicable, the relevant classes and will be displayed on the content to give a better visual indicator for which class is being used where.

In the case where the code or classes are not immediately apparent by the example, the code and classes will be provided nearby.