]> git.ipfire.org Git - thirdparty/foundation/foundation-sites.git/commitdiff
docs: add some docs around `code` mixins 10907/head
authorNicolas Coden <nicolas@ncoden.fr>
Sat, 3 Feb 2018 23:07:39 +0000 (00:07 +0100)
committerNicolas Coden <nicolas@ncoden.fr>
Sat, 3 Feb 2018 23:07:39 +0000 (00:07 +0100)
scss/typography/_helpers.scss

index 57afb58f13786ae944df290a26de0e8fcffeff2f..ce26b10b5a78ca901957da39057e3b08a196994c 100644 (file)
@@ -92,6 +92,8 @@ $code-block-margin-bottom: 1.5rem !default;
   }
 }
 
+/// Add basic styles for a code helper.
+/// See `code-inline` and `code-block` mixins.
 @mixin code-style {
   border: $code-border;
   background-color: $code-background;
@@ -101,6 +103,8 @@ $code-block-margin-bottom: 1.5rem !default;
   color: $code-color;
 }
 
+/// Make code helper from the `code-style` mixin inline.
+/// Used to generate `.code-inline`
 @mixin code-inline {
   display: inline;
   max-width: 100%;
@@ -109,6 +113,8 @@ $code-block-margin-bottom: 1.5rem !default;
   padding: $code-padding;
 }
 
+/// Make code helper from the `code-style` mixin a block.
+/// Used to generate `.code-block`
 @mixin code-block {
   display: block;
   overflow: auto;