]> git.ipfire.org Git - thirdparty/foundation/foundation-emails.git/commitdiff
Add docs page for callout
authorGeoff Kimball <geoff@zurb.com>
Fri, 4 Mar 2016 21:35:04 +0000 (13:35 -0800)
committerGeoff Kimball <geoff@zurb.com>
Fri, 4 Mar 2016 23:02:25 +0000 (15:02 -0800)
docs/pages/callout.md [new file with mode: 0644]
docs/partials/component-list.html
package.json

diff --git a/docs/pages/callout.md b/docs/pages/callout.md
new file mode 100644 (file)
index 0000000..cf5c33b
--- /dev/null
@@ -0,0 +1,40 @@
+---
+title: Callout
+description: Formerly panels, callouts can be used to create sidebar panels or call out important content in an email.
+sass: scss/components/_callout.scss
+tags:
+  - panel
+  - alert
+---
+
+## Basics
+
+Callouts use a full table structure, with the class `.callout` applied to the innermost `<th>`.
+
+When using [Inky](inky.html) HTML, the `<callout>` tag will create this structure for you.
+
+```inky
+<callout>
+  <p>Beware of the Kraken!</p>
+</callout>
+```
+
+---
+
+## Coloring Classes
+
+The color of a callout can be changed by adding the class `.success`, `.warning`, or `.alert` to the element.
+
+```inky
+<callout class="success">
+  <p>Successfully avoided Kraken.</p>
+</callout>
+
+<callout class="warning">
+  <p>There may be Krakens around.</p>
+</callout>
+
+<callout class="alert">
+  <p>Incoming Kraken!</p>
+</callout>
+```
index 787938926fec79d6c21683f91fb5428dadcf9028..c74aa018b1371b68d4526a457153ac2f7469231f 100644 (file)
@@ -5,11 +5,11 @@
   </p>
 
   <li class="docs-nav-title">Components</li>
-  <li><a href="">Alignment</a></li>
-  <li><a href="">Block Grid</a></li>
+  <li><a href="alignment.html">Alignment</a></li>
+  <li><a href="block-grid.html">Block Grid</a></li>
   <li><a href="button.html">Button</a></li>
-  <li><a href="">Callout</a></li>
-  <li><a href="">Global</a></li>
+  <li><a href="callout.html">Callout</a></li>
+  <li><a href="global.html">Global</a></li>
 
   <li class="docs-nav-title">Grid</li>
   <li><a href="">Grid</a></li>
index 617c2d5f1c4bcb66255782a7c55dbda987d6abcd..bab4c09eaf598e7010d0ebe07e7051995049fc38 100644 (file)
@@ -18,7 +18,7 @@
     "browser-sync": "^2.9.10",
     "cheerio": "^0.19.0",
     "foundation-docs": "zurb/foundation-docs",
-    "foundation-sites": "^6.0.5",
+    "foundation-sites": "^6.2.0",
     "gulp": "^3.8.11",
     "gulp-autoprefixer": "^2.3.1",
     "gulp-cached": "^1.1.0",