Selaa lähdekoodia

Markdown fixes

Kevin van Zonneveld 9 vuotta sitten
vanhempi
commit
8a5ead84ee
1 muutettua tiedostoa jossa 26 lisäystä ja 17 poistoa
  1. 26 17
      CONTRIBUTING.md

+ 26 - 17
CONTRIBUTING.md

@@ -1,25 +1,31 @@
 # Contributing Guidelines
 
 ## CSS Guidelines
+
 The CSS standards followed in this project closely resemble those from [Medium's CSS Guidelines](https://gist.github.com/fat/a47b882eb5f84293c4ed). If it's not mentioned here, follow their guidelines.
 
 ### Naming Conventions
+
 This project uses naming conventions adopted from the SUIT CSS framework. 
 [Read about them here](https://github.com/suitcss/suit/blob/master/doc/naming-conventions.md).
 
 To quickly summarize:
 
 #### Utilities
+
 Syntax: u-[sm-|md-|lg-]<utilityName>
-```
+
+```css
 .u-utilityName
 .u-floatLeft
 .u-lg-col6
 ```
 
 #### Components
+
 Syntax: [<namespace>-]<ComponentName>[-descendentName][--modifierName]
-```
+
+```css
 .twt-Button /* Namespaced component */
 .MyComponent /* Components pascal cased */
 .Button--default /* Modified button style */
@@ -34,35 +40,38 @@ Syntax: [<namespace>-]<ComponentName>[-descendentName][--modifierName]
 ```
 
 ### SASS
-This project uses SASS, with some limitations on nesting.  One-level deep nesting is allowed, but nesting may not extend a selector by using the `&` operator.  For example:
 
-```
-  /* BAD */
-  .Button {
-    &--disabled {
-      ...
-    }
-  }
+This project uses SASS, with some limitations on nesting.  One-level deep nesting is allowed, but nesting may not extend a selector by using the `&` operator.  For example:
 
-  /* GOOD */
-  .Button {
+```sass
+/* BAD */
+.Button {
+  &--disabled {
     ...
   }
+}
 
-  .Button--disabled {
-    ...
-  }
+/* GOOD */
+.Button {
+  ...
+}
+
+.Button--disabled {
+  ...
+}
 ```
 
 ### Mobile-first Responsive Approach
+
 Style to the mobile breakpoint with your selectors, then use `min-width` media queries to add any styles to the tablet or desktop breakpoints.
 
 ### Selector, Rule Ordering
+
 - All selectors are sorted alphabetically and by type.
 - HTML elements go above classes and IDs in a file.
 - Rules are sorted alphabetically.
 
-```
+```sass
 /* BAD */
 .wrapper {
   width: 940px;
@@ -91,4 +100,4 @@ h1 {
 .wrapper {
   margin: auto;
   width: 940px;
-}
+}