From: Joe Workman Date: Tue, 21 Jul 2020 17:38:24 +0000 (-0700) Subject: fix doc building X-Git-Tag: v2.3.0^2~3 X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=60a3f9158d0beb1e5f19d3d4dc5c97fe5b7eff8a;p=thirdparty%2Ffoundation%2Ffoundation-emails.git fix doc building --- diff --git a/docs/pages/gem-guide.md b/docs/pages/gem-guide.md index dc22a375..acd9af77 100644 --- a/docs/pages/gem-guide.md +++ b/docs/pages/gem-guide.md @@ -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 ``` diff --git a/docs/pages/migration.md b/docs/pages/migration.md index 26eae95a..1c8bff41 100644 --- a/docs/pages/migration.md +++ b/docs/pages/migration.md @@ -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 @@ -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
@@ -127,7 +127,7 @@ In Foundation for Emails 2, we’ve eliminated another tag in an effort to simpl Also, we stitched ``'s to ``'s because that allows Android 4 native to be responsive - win! -``` +```html
@@ -146,7 +146,7 @@ Also, we stitched ``'s to ``'s because that allows Android 4 native to b #### New Markup (Inky HTML) -``` +```html @@ -164,7 +164,7 @@ In an effort to unify the thinking across the Foundation family, we’ve removed #### Old Markup -``` +```html
@@ -188,14 +188,14 @@ In an effort to unify the thinking across the Foundation family, we’ve removed #### New Markup (Plain HTML) -``` +```html
- @@ -213,7 +213,7 @@ In an effort to unify the thinking across the Foundation family, we’ve removed #### New Markup (Inky HTML) -``` +```html @@ -234,7 +234,7 @@ The block grid has a minor syntax change with identifying the number of elements #### Old Markup -``` +```html
+
@@ -250,7 +250,7 @@ The block grid has a minor syntax change with identifying the number of elements #### New Markup (Plain HTML) -``` +```html
@@ -266,7 +266,7 @@ The block grid has a minor syntax change with identifying the number of elements #### New Markup (Inky HTML) -``` +```html Thing 1 Thing 2 @@ -282,7 +282,7 @@ Because we’ve eliminated the wrapper, offsets are now directly applied to the #### Old Markup -``` +```html
@@ -302,7 +302,7 @@ Because we’ve eliminated the wrapper, offsets are now directly applied to the #### New Markup (Plain HTML) -``` +```html
@@ -314,7 +314,7 @@ Because we’ve eliminated the wrapper, offsets are now directly applied to the #### New Markup (Inky HTML) -``` +```html @@ -332,7 +332,7 @@ In the previous version of F4E the text inside of the button was the only clicka #### Old Markup -``` +```html
@@ -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
@@ -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 ``` @@ -376,7 +376,7 @@ In an effort to unify the terminology across the Foundation family `panels` are #### Old Markup -``` +```html
@@ -389,7 +389,7 @@ In an effort to unify the terminology across the Foundation family `panels` are #### New Markup (Plain HTML) -``` +```html
@@ -402,7 +402,7 @@ In an effort to unify the terminology across the Foundation family `panels` are #### New Markup (Inky HTML) -``` +```html

One Word

@@ -440,10 +440,10 @@ You can wrap a callout around a `` or the content inside a ``. #### Old Markup (Plain HTML) -``` +```html -
+ @@ -472,7 +472,7 @@ You can wrap a callout around a `` or the content inside a ``. #### New Markup (Inky HTML) -``` +```html Item One Item Two @@ -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 ``` @@ -496,7 +496,7 @@ The spacer component creates consistant vertical spacing between or inside of el #### New Markup (Inky HTML) -``` +```html content here diff --git a/docs/pages/panini.md b/docs/pages/panini.md index eba208cb..c61ec758 100644 --- a/docs/pages/panini.md +++ b/docs/pages/panini.md @@ -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 `
  • `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. diff --git a/docs/pages/typography.md b/docs/pages/typography.md index b1a12e17..b9514a5b 100644 --- a/docs/pages/typography.md +++ b/docs/pages/typography.md @@ -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 `` and `` tags to denote text that should be displayed or read with emphasis. Browsers will bold and italicize them, while screen readers will read the words with emphasis. -``` +```html

    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 `` and `` tags to denote text that should be displayed or read with emphasis. Browsers will bold and italicize them, while screen readers will read the words with emphasis.

    ``` @@ -58,7 +58,7 @@ By inserting a `` 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

    Links are very standard, and the color is preset to the Foundation primary color. Learn more about Foundation's global colors.

    ``` @@ -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
    ```