From: Geoff Kimball Date: Wed, 6 Jan 2016 01:31:46 +0000 (-0800) Subject: Remove old test folder and update readme to match X-Git-Tag: v2.0.0-rc.1~55 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a0119382a2fdfc01b4a1c00d4d47aa9beb4e4e6e;p=thirdparty%2Ffoundation%2Ffoundation-emails.git Remove old test folder and update readme to match --- diff --git a/README.md b/README.md index 55870c17..6c45cc4b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Foundation for Emails is the second installment of what was previously known as While in the process of creating our official docs, this README.md file will be your guide to installing, running, and documentation for F4E. If you need to brush up on Ink, you can still find our [old docs here.](http://foundation.zurb.com/emails/docs.html) ## Requirements -Requires NodeJS to be installed on your machine. Works with 0.10, 0.12, and 4.1! **Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.** +Requires NodeJS to be installed on your machine. Works with 0.12, and 4.x, and 5.x! **Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.** The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through [MinGW](http://www.mingw.org/), and Mac users can install it through the [Xcode Command-line Tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/). @@ -36,13 +36,13 @@ Foundation for Emails utilizes [Panini](https://github.com/zurb/panini), our sup foundation-emails/ ├── _build/ │ └── ... -├── test/ +├── foundation-emails-template/ │ └── layouts │ └── ... │ └── pages │ └── ... ``` -You'll be working within the `test/layouts` and `test/pages` to write your HTML emails. The `_build` directory will have all of your outputted emails. +You'll be working within the `foundation-emails-template/layouts/` and `foundation-emails-template/pages/` to write your HTML emails. The `dist/` directory will have all of your outputted emails. ## Commands You'll have two commands that will give you all the tools you need for F4E. diff --git a/foundation-emails-template b/foundation-emails-template index 7be1038c..ef52c6d4 160000 --- a/foundation-emails-template +++ b/foundation-emails-template @@ -1 +1 @@ -Subproject commit 7be1038ca4c2269b28cd727100d242e240340c40 +Subproject commit ef52c6d49d097313924f4240d6a16920bdd95855 diff --git a/test/gulpfile.js b/test/gulpfile.js deleted file mode 100644 index 8f92372c..00000000 --- a/test/gulpfile.js +++ /dev/null @@ -1,94 +0,0 @@ -var gulp = require('gulp'); -var $ = require('gulp-load-plugins')(); -var mq = require('media-query-extractor'); -var rimraf = require('rimraf'); -var panini = require('panini'); -var yargs = require('yargs').argv; -var sequence = require('run-sequence'); -var browser = require('browser-sync'); - -console.log(process.argv); - -// Look for the --production flag -var isProduction = !!(yargs.production); - -// Delete the "dist" folder -// This happens every time a build starts -gulp.task('clean', function(done) { - rimraf('../_build', done); -}); - -// Compile layouts, pages, and partials into flat HTML files -// Then parse using Inky templates -gulp.task('pages', function() { - return gulp.src('./pages/**/*.html') - .pipe(panini({ - root: './pages', - layouts: './layouts' - })) - .pipe($.inky()) - .pipe(gulp.dest('../_build')); -}); - -// Compile Sass into CSS -gulp.task('sass', function() { - return gulp.src('./scss/app.scss') - .pipe($.if(!isProduction, $.sourcemaps.init())) - .pipe($.sass().on('error', $.sass.logError)) - .pipe($.if(!isProduction, $.sourcemaps.write())) - .pipe(gulp.dest('../_build/css')); -}); - -// Inline CSS and minify HTML -gulp.task('inline', function() { - return gulp.src('../_build/*.html') - .pipe(inline({ - css: '../_build/css/app.css' - })) - .pipe(gulp.dest('../_build')); -}); - -gulp.task('server', ['build'], function() { - browser.init({ - server: '../_build' - }); -}); - -// Build the "dist" folder by running all of the above tasks -gulp.task('build', function(cb) { - var tasks = ['clean', ['pages', 'sass']]; - if (isProduction) tasks.push('inline'); - tasks.push(cb); - sequence.apply(this, tasks); -}); - -// Build emails, run the server, and watch for file changes -gulp.task('default', ['server'], function() { - gulp.watch('./pages/**/*.html', ['pages', browser.reload]); - gulp.watch(['../scss/**/*.scss', './scss/**/*.scss'], ['sass', browser.reload]); -}); - -function inline(options) { - var lazypipe = require('lazypipe'); - var cssPath = options.css; - var cssMqPath = cssPath.replace(/\.css$/, '-mq.css'); - - // Extracts media query-specific CSS into a separate file - mq(cssPath, cssMqPath, [ - 'only screen and (max-width: 580px)|' + cssMqPath - ]); - - var pipe = lazypipe() - .pipe($.inlineCss) - .pipe($.inject, gulp.src(cssMqPath), { - transform: function(path, file) { - return ''; - } - }) - .pipe($.htmlmin, { - collapseWhitespace: false, - minifyCSS: true - }); - - return pipe(); -} diff --git a/test/layouts/default.html b/test/layouts/default.html deleted file mode 100644 index 7c02b63d..00000000 --- a/test/layouts/default.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - - - - - -
-
- {{> body}} -
-
- - \ No newline at end of file diff --git a/test/pages/basic.html b/test/pages/basic.html deleted file mode 100644 index b8520e7a..00000000 --- a/test/pages/basic.html +++ /dev/null @@ -1,76 +0,0 @@ - - -
- - - - - - - Basic - - - -
- -
- - - -

Hi, Susan Calvin

-

Phasellus dictum sapien a neque luctus cursus. Pellentesque sem dolor, fringilla et pharetra vitae.

-

Phasellus dictum sapien a neque luctus cursus. Pellentesque sem dolor, fringilla et pharetra vitae. consequat vel lacus. Sed iaculis pulvinar ligula, ornare fringilla ante viverra et. In hac habitasse platea dictumst. Donec vel orci mi, eu congue justo. Integer eget odio est, eget malesuada lorem. Aenean sed tellus dui, vitae viverra risus. Nullam massa sapien, pulvinar eleifend fringilla id, convallis eget nisi. Mauris a sagittis dui. Pellentesque non lacinia mi. Fusce sit amet libero sit amet erat venenatis sollicitudin vitae vel eros. Cras nunc sapien, interdum sit amet porttitor ut, congue quis urna.

-
-
- - - -

Phasellus dictum sapien a neque luctus cursus. Pellentesque sem dolor, fringilla et pharetra vitae. Click it! »

- -
-
- - - -
Connect With Us:
- - - - - -
- - - - - -
- - - - -
- Google + -
- -
- - -
Contact Info:
-

Phone: 408.341.0600

-

Email: hseldon@trantor.com

- -
-
- - -
-

Terms | Privacy | Unsubscribe

-
-
-
-
\ No newline at end of file diff --git a/test/pages/index.html b/test/pages/index.html deleted file mode 100644 index 14dfcc19..00000000 --- a/test/pages/index.html +++ /dev/null @@ -1,76 +0,0 @@ - - -
- - - - - - - Basic - - - -
- -
- - - -

Hi, Susan Calvin

-

Phasellus dictum sapien a neque luctus cursus. Pellentesque sem dolor, fringilla et pharetra vitae.

-

Phasellus dictum sapien a neque luctus cursus. Pellentesque sem dolor, fringilla et pharetra vitae. consequat vel lacus. Sed iaculis pulvinar ligula, ornare fringilla ante viverra et. In hac habitasse platea dictumst. Donec vel orci mi, eu congue justo. Integer eget odio est, eget malesuada lorem. Aenean sed tellus dui, vitae viverra risus. Nullam massa sapien, pulvinar eleifend fringilla id, convallis eget nisi. Mauris a sagittis dui. Pellentesque non lacinia mi. Fusce sit amet libero sit amet erat venenatis sollicitudin vitae vel eros. Cras nunc sapien, interdum sit amet porttitor ut, congue quis urna.

-
-
- - - -

Phasellus dictum sapien a neque luctus cursus. Pellentesque sem dolor, fringilla et pharetra vitae. Click it! »

- -
-
- - - -
Connect With Us:
- - - - - -
- - - - - -
- - - - -
- Google + -
- -
- - -
Contact Info:
-

Phone: 408.341.0600

-

Email: hseldon@trantor.com

- -
-
- - -
-

Terms | Privacy | Unsubscribe

-
-
-
-
diff --git a/test/scss/_settings.scss b/test/scss/_settings.scss deleted file mode 100644 index bfd0a1f5..00000000 --- a/test/scss/_settings.scss +++ /dev/null @@ -1,125 +0,0 @@ -// Foundation for Emails Settings -// ------------------------------ -// -// Table of Contents: -// -// 1. Global -// 2. Grid -// 3. Block Grid -// 4. Button -// 5. Callout -// 6. Media Query -// 7. Normalize -// 8. Thumbnail -// 9. Typography - - -// 1. Global -// --------- - -$primary-color: #2199e8; -$secondary-color: #777; -$success-color: #3adb76; -$warning-color: #ffae00; -$alert-color: #ec5840; -$light-gray: #f3f3f3; -$medium-gray: #cacaca; -$dark-gray: #8a8a8a; -$black: #0a0a0a; -$white: #fefefe; -$pre-color: #ff6908; -$column-gutter: 20px; -$container-width: 580px; -$global-radius: 3px; -$global-rounded: 500px; - -// 2. Grid -// ------- - -$grid-column-count: 12; -$wrapper-padding-top: 10px; -$column-padding-bottom: 10px; -$sub-column-padding-right: $column-gutter / 2; - -// 3. Block Grid -// ------------- - -$block-grid-elements: 8; -$block-grid-spacing: $column-gutter; - -// 4. Button -// --------- - -$button-padding: 12px 0 12px 0; -$button-padding-tiny: 5px 0 4px 0; -$button-padding-small: 8px 0 7px; -$button-padding-large: 21px 0 18px; -$button-font-color: $white; -$button-font-color-alt: $medium-gray; -$button-font-weight: bold; -$button-font-size: 20px; -$button-font-size-tiny: 12px; -$button-font-size-small: 16px; -$button-font-size-large: 24px; -$button-background-color: $primary-color; -$button-border: 1px solid darken($button-background-color, 10%); - -// 5. Callout -// ---------- - -$callout-background-color: $light-gray; -$callout-padding: 10px; -$callout-border: 1px solid darken($callout-background-color, 20%); -$callout-border-success: 1px solid darken($success-color, 20%); -$callout-border-warning: 1px solid darken($warning-color, 20%); -$callout-border-alert: 1px solid darken darken($alert-color, 20%); - -// 6. Media Query -// -------------- - -$small-container-width: 95%; -$small-range: $container-width; - -// 7. Normalize -// ------------ - -$hr-color: $medium-gray; -$hr-height: 1px; - -// 8. Thumbnail -// ------------ - -$thumbnail-shadow-h: 0; -$thumbnail-shadow-v: 0; -$thumbnail-shadow-blur: 6px; -$thumbnail-shadow-spread: 1px; -$thumbnail-shadow-color: $primary-color; -$thumbnail-shadow-opacity: 0.5; - -// 9. Typography -// ------------- - -$global-font-color: $black; -$global-font-family: Helvetica, Arial, sans-serif; -$global-font-weight: normal; -$global-line-height: 1.3; -$body-font-size: 14px; -$body-line-height: 19px; -$header-font-family: Georgia, Times, serif; -$h1-font-size: 40px; -$h2-font-size: 36px; -$h3-font-size: 32px; -$h4-font-size: 28px; -$h5-font-size: 24px; -$h6-font-size: 20px; -$small-font-size: 10px; -$paragraph-lead-font-size: 18px; -$paragraph-lead-line-height: 21px; -$paragraph-margin-bottom: 10px; -$text-padding: 10px; -$anchor-text-decoration: none; -$anchor-font-color: $primary-color; -$anchor-font-color-visited: $anchor-font-color; -$anchor-font-color-hover: darken($primary-color, 10%); -$anchor-font-color-active: $anchor-font-color-hover; - diff --git a/test/scss/app.scss b/test/scss/app.scss deleted file mode 100644 index 4fc8b0d8..00000000 --- a/test/scss/app.scss +++ /dev/null @@ -1,2 +0,0 @@ -@import 'settings'; -@import '../../scss/ink';