]> git.ipfire.org Git - thirdparty/foundation/foundation-emails.git/commitdiff
fix doc building
authorJoe Workman <joe@workmanmail.com>
Tue, 21 Jul 2020 17:38:24 +0000 (10:38 -0700)
committerJoe Workman <joe@workmanmail.com>
Tue, 21 Jul 2020 17:38:24 +0000 (10:38 -0700)
docs/pages/gem-guide.md
docs/pages/migration.md
docs/pages/panini.md
docs/pages/typography.md

index dc22a375f7a383d10359686647d9d5472da3e34c..acd9af779a8797f81bf517031ed8f1de75a3d9e2 100644 (file)
@@ -41,7 +41,7 @@ rails g inky:install
 
 Rename your email templates to use the `.inky` file extension. Note that you'll still be able to use ERB within the `.inky` templates:
 
-```
+```ruby
 welcome.html      => welcome.html.inky
 pw_reset.html.erb => pw_reset.html.inky
 ```
index 26eae95aa7281881a3794e73411d8740626bbb14..1c8bff41690c7c2ec7d49d42b82ac740a3d5a6e6 100644 (file)
@@ -43,7 +43,7 @@ What’s new that you might want to use:
 
 With Foundation for Emails 2, confusing and tedious tables are a thing of the past. The new Inky markup will save you time and energy coding your emails. It looks like:
 
-```
+```html
 <container>
   <row>
     <column small="12" large="4">
@@ -94,7 +94,7 @@ Version 2 now has more alignment classes:
 
 In the Ink 1.0, we needed extra tags to support a wrapper element. This used to control the gutter and margins of a column.
 
-```
+```html
 <table class="container">
   <tr>
     <td>
@@ -127,7 +127,7 @@ In Foundation for Emails 2, we’ve eliminated another tag in an effort to simpl
 
 Also, we stitched `<td>`'s to `<th>`'s because that allows Android 4 native to be responsive - win!
 
-```
+```html
 <table class="container">
   <tr>
     <td>
@@ -146,7 +146,7 @@ Also, we stitched `<td>`'s to `<th>`'s because that allows Android 4 native to b
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <container>
   <row>
     <columns small="12" large="12">
@@ -164,7 +164,7 @@ In an effort to unify the thinking across the Foundation family, we’ve removed
 
 #### Old Markup
 
-```
+```html
 <table class="container">
   <tr>
     <td class="wrapper last">
@@ -188,14 +188,14 @@ In an effort to unify the thinking across the Foundation family, we’ve removed
 
 #### New Markup (Plain HTML)
 
-```
+```html
 <table class="container">
   <tr>
     <td>
 
       <table class="row">
         <tr>
-          <th class="first large-6 small-6 columns">      
+          <th class="first large-6 small-6 columns">
 
           </th>
 
@@ -213,7 +213,7 @@ In an effort to unify the thinking across the Foundation family, we’ve removed
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <container>
   <row>
     <columns small="6">
@@ -234,7 +234,7 @@ The block grid has a minor syntax change with identifying the number of elements
 
 #### Old Markup
 
-```
+```html
 <table class="block-grid three-up">
   <tr>
     <td>
@@ -250,7 +250,7 @@ The block grid has a minor syntax change with identifying the number of elements
 
 #### New Markup (Plain HTML)
 
-```
+```html
 <table class="block-grid up-3">
   <tr>
     <th class="column first">
@@ -266,7 +266,7 @@ The block grid has a minor syntax change with identifying the number of elements
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <block-grid up="3">
   <column>Thing 1</column>
   <column>Thing 2</column>
@@ -282,7 +282,7 @@ Because we’ve eliminated the wrapper, offsets are now directly applied to the
 
 #### Old Markup
 
-```
+```html
 <table class="row">
   <tr>
     <td class="wrapper offset-by-four">
@@ -302,7 +302,7 @@ Because we’ve eliminated the wrapper, offsets are now directly applied to the
 
 #### New Markup (Plain HTML)
 
-```
+```html
 <table class="row">
   <tr>
     <th class="small-4 small-offset-8 large-4 large-offset-8 columns">
@@ -314,7 +314,7 @@ Because we’ve eliminated the wrapper, offsets are now directly applied to the
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <row>
   <columns small="4" large="4" class="small-offset-8 large-offset-8">
 
@@ -332,7 +332,7 @@ In the previous version of F4E the text inside of the button was the only clicka
 
 #### Old Markup
 
-```
+```html
 <table class="button">
   <tr>
     <td>
@@ -344,7 +344,7 @@ In the previous version of F4E the text inside of the button was the only clicka
 
 #### New Markup (Plain HTML)
 
-```
+```html
 <table class="button">
   <tr>
     <td>
@@ -362,7 +362,7 @@ In the previous version of F4E the text inside of the button was the only clicka
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <button href="https://zurb.com"></button>
 ```
 
@@ -376,7 +376,7 @@ In an effort to unify the terminology across the Foundation family `panels` are
 
 #### Old Markup
 
-```
+```html
 <table class="twelve columns">
   <tr>
     <td class="panel">
@@ -389,7 +389,7 @@ In an effort to unify the terminology across the Foundation family `panels` are
 
 #### New Markup (Plain HTML)
 
-```
+```html
 <table class="callout">
   <tr>
     <td class="callout-inner">
@@ -402,7 +402,7 @@ In an effort to unify the terminology across the Foundation family `panels` are
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <row>
   <columns small="6">
     <p>One Word</p>
@@ -440,10 +440,10 @@ You can wrap a callout around a `<row>` or the content inside a `<column>`.
 
 #### Old Markup (Plain HTML)
 
-```
+```html
 <table class="container">
   <tr>
-    <td>     
+    <td>
 
       <table class="menu">
         <tr>
@@ -472,7 +472,7 @@ You can wrap a callout around a `<row>` or the content inside a `<column>`.
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <menu>
   <item href="one.html">Item One</item>
   <item href="one.html">Item Two</item>
@@ -486,7 +486,7 @@ The menu component can be used to create a simple set of links comonly used in h
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <spacer size="100"></spacer>
 ```
 
@@ -496,7 +496,7 @@ The spacer component creates consistant vertical spacing between or inside of el
 
 #### New Markup (Inky HTML)
 
-```
+```html
 <wrapper>
   content here
 </wrapper>
index eba208cbcbf2436d0f234309c700c8a17749a8da..c61ec758bd3d1c835299082bebdbfde12955b18d 100644 (file)
@@ -174,7 +174,7 @@ Lorem ipsum [dolor sit amet](https://html5zombo.com), consectetur adipisicing el
 
 If you don't see the right helper, you can write your own. Add a javascript file to 'src/helpers', restart npm, then call it in your templates.
 
-```
+```javascript
 // Example file src/helpers/bold.js
 module.exports = function(options) {
   // options.fn(this) = Handlebars content between {{#bold}} HERE {{/bold}}
@@ -184,7 +184,7 @@ module.exports = function(options) {
 ```
 Then in your projects call your custom `{{#bold}}` helper
 
-```
+```handlebars
 {{#bold}}ideas{{/bold}}
 ```
 
@@ -213,7 +213,7 @@ Now, you can insert the values of these variables into the `index.html` page, *o
 
 Variables can also be added globally by creating an external JSON or YML file, and adding it to the `src/data` folder in your project. Let's create a file called `breakfast.yml`:
 
-```
+```yaml
 - eggs
 - bacon
 - toast
@@ -233,7 +233,7 @@ This code will print three `<li>`s, one for each item in the file.
 
 ## Tutorials
 
-[Staying D.R.Y. with Panini](https://zurb.com/university/lessons/staying-d-r-y-with-panini) 
+[Staying D.R.Y. with Panini](https://zurb.com/university/lessons/staying-d-r-y-with-panini)
 Panini comes with tons of Handlebars helpers built in, like a repeat helper or markdown parser, but in this lesson we’ll take a look at creating a custom month/year helper for an HTML email.
 
 
index b1a12e176adc159d4f4bc37b83c9c09be4cf4b78..b9514a5be66f2fc5fb685d9d44311a7f0ab40c90 100644 (file)
@@ -8,7 +8,7 @@ sass: scss/components/_typography.scss
 
 This is a paragraph. Paragraphs are preset with a font size, line height and spacing to match the overall vertical rhythm. To show what a paragraph looks like this needs a little more content—so, did you know that female Giant Squids on average are around twice the size of (and around 10 feet longer than) their potential mates? Pretty cool. Use the `<strong>` and `<em>` tags to denote text that should be displayed or read with emphasis. Browsers will <strong>bold</strong> and <em>italicize</em> them, while screen readers will read the words with <em>emphasis</em>.
 
-```
+```html
 <p>This is a paragraph. Paragraphs are preset with a font size, line height and spacing to match the overall vertical rhythm. To show what a paragraph looks like this needs a little more content—so, did you know that female Giant Squids on average are around twice the size of (and around 10 feet longer than) their potential mates? Pretty cool. Use the `<strong>` and `<em>` tags to denote text that should be displayed or read with emphasis. Browsers will <strong>bold</strong> and <em>italicize</em> them, while screen readers will read the words with <em>emphasis</em>.</p>
 ```
 
@@ -58,7 +58,7 @@ By inserting a `<small>` element into a header Foundation will scale the header
 
 Links are very standard, and the color is preset to the Foundation primary color. [Learn more about Foundation's global colors](global.html).
 
-```
+```html
 <p>Links are very standard, and the color is preset to the Foundation primary color. <a href="global.html">Learn more about Foundation's global colors.</a></p>
 ```
 
@@ -68,6 +68,6 @@ Links are very standard, and the color is preset to the Foundation primary color
 
 Use dividers to define thematic breaks between paragraphs or sections of your email.
 
-```
+```html
 <hr/>
 ```