Last active
January 30, 2016 20:00
-
-
Save iods/6168b13b096077bf82d3 to your computer and use it in GitHub Desktop.
How I document my CSS before preprocessing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /**--------------------------------------------------------------------------- | |
| * {{Project}} Stylesheet | |
| * | |
| * {{Description for the stylesheet from a high-level}} | |
| * | |
| * Markup: {{filename.css}} | |
| * Project: {{Project}} | |
| * Version: {{Version}} {{Created On}} | |
| * Description: {{Project Description}} | |
| * Website: {{Project Git Repository}} | |
| * | |
| * Author: {{Author}} | |
| ---------------------------------------------------------------------------*/ | |
| /** | |
| * TABLE OF CONTENTS | |
| * | |
| * SECTION ONE | |
| * Sub-Section..........Description of the sub-section for quick reference. | |
| * Sub-Section Two......Description of the sub-section for quick reference. | |
| * | |
| * SECTION TWO | |
| * Sub-Section Three....Description of the sub-section for quick reference. | |
| * Sub-Section Four.....Description of the sub-section for quick reference. | |
| * | |
| * TESTS................Declarations loaded independently for test-case. | |
| */ | |
| /*----------------------------------------- | |
| * SECTION - @Sub-Section | |
| *---------------------------------------*/ | |
| /** | |
| * Extends 'foo' in styles.css | |
| * | |
| * Due to the fixed navbar the body will need to have | |
| * a margin of 60px from the top to properly display | |
| * the top navbar. | |
| */ | |
| .foo {} | |
| /*----------------------------------------- | |
| * SECTION TWO - @Sub-Section | |
| *---------------------------------------*/ | |
| h1, | |
| h2, | |
| h3, | |
| h4, | |
| h5, | |
| h6 { | |
| font-family: sans-serif; | |
| } | |
| /**---------------------------------------- | |
| * TESTS | |
| * --------------------------------------*/ |
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Using the @ in section blocks allows for easy searching when browsing large documents.