]> git.ipfire.org Git - thirdparty/foundation/foundation-emails.git/commitdiff
Add Using Sass page and add pink CSS that's not activated
authorGeoff Kimball <geoff@zurb.com>
Fri, 4 Mar 2016 23:37:25 +0000 (15:37 -0800)
committerGeoff Kimball <geoff@zurb.com>
Fri, 4 Mar 2016 23:37:25 +0000 (15:37 -0800)
docs/assets/img/logos/sass-logo.svg [new file with mode: 0644]
docs/assets/scss/docs.scss
docs/pages/sass.md [new file with mode: 0644]
docs/partials/component-list.html
docs/partials/footer.html

diff --git a/docs/assets/img/logos/sass-logo.svg b/docs/assets/img/logos/sass-logo.svg
new file mode 100644 (file)
index 0000000..194e860
--- /dev/null
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="512" height="384" viewBox="0 0 512 384"><path fill="#CF649A" d="M440.6 220.6c-17.9.1-33.4 4.4-46.4 10.8-4.8-9.5-9.6-17.8-10.4-24-.9-7.2-2-11.6-.9-20.2s6.1-20.8 6.1-21.8c-.1-.9-1.1-5.3-11.4-5.4-10.3-.1-19.2 2-20.2 4.7s-3 8.9-4.3 15.3c-1.8 9.4-20.6 42.7-31.3 60.2-3.5-6.8-6.5-12.8-7.1-17.6-.9-7.2-2-11.6-.9-20.2s6.1-20.8 6.1-21.8c-.1-.9-1.1-5.3-11.4-5.4-10.3-.1-19.2 2-20.2 4.7s-2.1 9.1-4.3 15.3c-2.1 6.2-27.1 61.8-33.6 76.3-3.3 7.4-6.2 13.3-8.3 17.3s-.1.3-.3.7c-1.8 3.4-2.8 5.3-2.8 5.3v.1c-1.4 2.5-2.9 4.9-3.6 4.9-.5 0-1.5-6.7.2-15.9 3.7-19.3 12.7-49.4 12.6-50.5 0-.5 1.7-5.8-5.8-8.5-7.3-2.7-9.9 1.8-10.5 1.8-.6 0-1.1 1.6-1.1 1.6s8.1-33.9-15.5-33.9c-14.8 0-35.2 16.1-45.3 30.8-6.4 3.5-20 10.9-34.4 18.8-5.5 3-11.2 6.2-16.6 9.1l-1.1-1.2c-28.6-30.5-81.5-52.1-79.3-93.1.8-14.9 6-54.2 101.6-101.8 78.3-39 141-28.3 151.9-4.5 15.5 34-33.5 97.2-114.9 106.3-31 3.5-47.3-8.5-51.4-13-4.3-4.7-4.9-4.9-6.5-4-2.6 1.4-1 5.6 0 8.1 2.4 6.3 12.4 17.5 29.4 23.1 14.9 4.9 51.3 7.6 95.3-9.4 49.3-19.1 87.8-72.1 76.5-116.4-11.5-45.1-86.3-59.9-157-34.8-42.1 15-87.7 38.4-120.5 69.1-39 36.4-45.2 68.2-42.6 81.4 9.1 47.1 74 77.8 100 100.5-1.3.7-2.5 1.4-3.6 2-13 6.4-62.5 32.3-74.9 59.7-14 31 2.2 53.3 13 56.3 33.4 9.3 67.6-7.4 86.1-34.9 18.4-27.5 16.2-63.2 7.7-79.5l-.3-.6 10.2-6c6.6-3.9 13.1-7.5 18.8-10.6-3.2 8.7-5.5 19-6.7 34-1.4 17.6 5.8 40.4 15.3 49.4 4.2 3.9 9.2 4 12.3 4 11 0 16-9.1 21.5-20 6.8-13.3 12.8-28.7 12.8-28.7s-7.5 41.7 13 41.7c7.5 0 15-9.7 18.4-14.7v.1s.2-.3.6-1c.8-1.2 1.2-1.9 1.2-1.9v-.2c3-5.2 9.7-17.1 19.7-36.8 12.9-25.4 25.3-57.2 25.3-57.2s1.2 7.8 4.9 20.6c2.2 7.6 7 15.9 10.7 24-3 4.2-4.8 6.6-4.8 6.6l.1.1c-2.4 3.2-5.1 6.6-7.9 10-10.2 12.2-22.4 26.1-24 30.1-1.9 4.7-1.5 8.2 2.2 11 2.7 2 7.5 2.4 12.6 2 9.2-.6 15.6-2.9 18.8-4.3 5-1.8 10.7-4.5 16.2-8.5 10-7.4 16.1-17.9 15.5-31.9-.3-7.7-2.8-15.3-5.9-22.5.9-1.3 1.8-2.6 2.7-4 15.8-23.1 28-48.5 28-48.5s1.2 7.8 4.9 20.6c1.9 6.5 5.7 13.6 9.1 20.6-14.8 12.1-24.1 26.1-27.3 35.3-5.9 17-1.3 24.7 7.4 26.5 3.9.8 9.5-1 13.7-2.8 5.2-1.7 11.5-4.6 17.3-8.9 10-7.4 19.6-17.7 19.1-31.6-.3-6.4-2-12.7-4.3-18.7 12.6-5.2 28.9-8.2 49.6-5.7 44.5 5.2 53.3 33 51.6 44.6-1.7 11.6-11 18-14.1 20-3.1 1.9-4.1 2.6-3.8 4 .4 2.1 1.8 2 4.5 1.6 3.7-.6 23.4-9.5 24.2-30.9 1.2-27.5-24.9-57.5-71.2-57.2zm-343.2 115.7c-14.7 16.1-35.4 22.2-44.2 17-9.5-5.5-5.8-29.2 12.3-46.3 11-10.4 25.3-20 34.7-25.9 2.1-1.3 5.3-3.2 9.1-5.5.6-.4 1-.6 1-.6.7-.4 1.5-.9 2.3-1.4 6.7 24.4.3 45.8-15.2 62.7zm107.5-73.1c-5.1 12.5-15.9 44.6-22.4 42.8-5.6-1.5-9-25.8-1.1-49.8 4-12.1 12.5-26.5 17.5-32.1 8.1-9 16.9-12 19.1-8.3 2.6 4.8-9.9 39.6-13.1 47.4zm88.7 42.4c-2.2 1.1-4.2 1.9-5.1 1.3-.7-.4.9-1.9.9-1.9s11.1-11.9 15.5-17.4c2.5-3.2 5.5-6.9 8.7-11.1v1.2c0 14.4-13.8 24-20 27.9zm68.4-15.6c-1.6-1.2-1.4-4.9 4-16.5 2.1-4.6 6.9-12.3 15.2-19.6 1 3 1.6 5.9 1.5 8.6-.1 18-12.9 24.7-20.7 27.5z"/></svg>
\ No newline at end of file
index 89c87089416d04ef1676ea41e916ab9076abb69d..2cc73436e89efc4e992d5913f6b8395afc121ec0 100644 (file)
@@ -7,6 +7,14 @@
 //
 // Feel free to submit pull requests to foundation-docs like you would Foundation itself!
 
+// $foundation-palette: (
+//   primary: #cc7691,
+//   secondary: #777,
+//   success: #3adb76,
+//   warning: #ffae00,
+//   alert: #ec5840,
+// );
+
 @import 'node_modules/foundation-sites/scss/foundation';
 @import 'node_modules/motion-ui/src/motion-ui';
 
 @include motion-ui-transitions;
 
 @import 'node_modules/foundation-docs/scss/foundation-docs';
+
+// .docs-nav.menu {
+//   background-color: #fefaff;
+//
+//   a:hover {
+//     background: rgba($primary-color, 0.1);
+//   }
+// }
+//
+// .docs-nav-title {
+//   color: #9974a1;
+// }
+//
+// .docs-newsletter {
+//   background-color: darken($primary-color, 15%);
+//
+//   .button {
+//     color: $primary-color;
+//     background: white;
+//     font-weight: bold;
+//
+//     &:hover {
+//       background: #f9f9f9;
+//     }
+//   }
+// }
+//
+// .docs-emails .zurb-footer-top {
+//   background-color: darken($primary-color, 25%);
+// }
diff --git a/docs/pages/sass.md b/docs/pages/sass.md
new file mode 100644 (file)
index 0000000..df7cff9
--- /dev/null
@@ -0,0 +1,96 @@
+---
+title: Using Sass
+description: Foundation for Emails is written in Sass, which allows us to make the codebase customizable and flexible.
+---
+
+<div class="primary callout">
+  <p>Not familiar with Sass? The [official tutorial](http://sass-lang.com/guide) on sass-lang.com is a great place to start.</p>
+</div>
+
+## Compatibility
+
+<img src="assets/img/logos/sass-logo.svg" alt="Sass logo" class="float-right" style="width: 150px; height: 150px; margin-left: 1rem;">
+
+**Foundation for Sites can be compiled with Ruby Sass and libsass.** We tend to stick to the latest versions of both compilers when possible. Our documentation, as well as the ZURB Email Stack, are compiled with [node-sass](https://github.com/sass/node-sass), a Node port of libsass. We recommend these versions of either compiler:
+
+- Ruby Sass **3.4+**
+- node-sass **3.4.2+** (libsass **3.3.2**)
+
+---
+
+## Loading the Framework
+
+If you're using the [ZURB Email Stack](zurb-stack.html) to create emails, Sass has already been set up for you. However, it's also easy to incorporate the Foundation for Emails Sass into your own email workflow.
+
+To get started, first install the framework files using Bower or npm.
+
+```bash
+npm install foundation-emails --save
+bower install foundation-emails --save
+```
+
+Next, add the framework files as an import path in Sass. How you do this depends on your build process, but the path is the same regardless: `[packages_folder]/foundation-emails/scss`
+
+Here's an example using grunt-contrib-sass:
+
+```js
+grunt.initConfig({
+  sass: {
+    dist: {
+    options: {
+        loadPath: ['node_modules/foundation-sites/scss']
+      }
+    }
+  }
+});
+```
+
+If you're using Compass, open your project's `config.rb` and add the import path there:
+
+```ruby
+add_import_path "node_modules/foundation-sites/scss"
+```
+
+Finally, add an `@import` statement to the top of your main Sass file.
+
+```scss
+@import 'foundation';
+```
+
+You're also going to want a settings file for your project, which will allow you to modify the default styles of Foundation for Emails. **[Download the latest settings file here](https://raw.githubusercontent.com/zurb/foundation-emails/master/scss/settings/_settings.scss)**, add it to your project as `_settings.scss`, then import it *before* Foundation itself.
+
+```scss
+@import 'settings';
+@import 'foundation';
+```
+
+---
+
+## The Settings File
+
+All Foundation projects include a **settings file**, named `_settings.scss`. If you're using the ZURB Stack, you can find the settings file under `src/assets/scss/`. If you're installing the framework standalone using Bower or npm, there's a settings file included in those packages, which you can copy into your own Sass folder to work with.
+
+Every component includes a set of variables that modify core structural or visual styles. If there's something you can't customize with a variable, you can just write your own CSS to add it.
+
+<div class="callout warning">
+  <p>Once you've set up a new project, your settings file can't be automatically updated when new versions change, add, or remove variables. Keep tabs on new <a href="https://github.com/zurb/foundation-emails/releases">Foundation releases</a> so you know when things change.</p>
+</div>
+
+Here's an example set of settings variables. These change the default styling of [buttons](button.html):
+
+```scss
+// Text color of buttons.
+$button-color: $white !default;
+
+// Text color of buttons with a light background.
+$button-color-alt: $medium-gray !default;
+
+// Font weight of buttons.
+$button-font-weight: bold !default;
+
+// Background color of buttons.
+$button-background: $primary-color !default;
+
+// Border around buttons.
+$button-border: 2px solid $button-background !default;
+```
index 77be39c398fa870131a449f30c7f20961c288917..ff749ba8fda00164ff51032417ff1e080c023733 100644 (file)
@@ -7,8 +7,8 @@
   <li class="docs-nav-title">Guides</li>
   <li><a href="getting-started.html">Getting Started</a></li>
   <li><a href="installing.html">Installing</a></li>
-  <li><a href="sass.html">Sass</a></li>
-  <li><a href="inky.html">Inky</a></li>
+  <li><a href="sass.html">Using Sass</a></li>
+  <li><a href="inky.html">Using Inky</a></li>
   <li><a href="zurb-stack.html">ZURB Stack</a></li>
   <li><a href="compatibility.html">Compatibility</a></li>
   <li><a href="migration.html">Migrate from Ink</a></li>
index 31614ac70180203cee9690c5c186d8360ea46cc4..922b41e852aa80b8c99515aaadde0e617a55f023 100644 (file)
@@ -23,8 +23,8 @@
   <div class="row property">
     <div class="medium-4 columns">
       <div class="property-info">
-        <h3>Foundation for Sites</h3>
-        <p>Foundation is a responsive front-end framework made by <a href="http://zurb.com">ZURB</a>, a product design company in Campbell, CA. This framework is the result of building web products &amp; services since 1998.
+        <h3>Foundation for Emails</h3>
+        <p>Foundation for Emails is a framework for responsive HTML emails created by <a href="http://zurb.com">ZURB</a>, a product design company in Campbell, CA. This framework is the result of building web products &amp; services since 1998.
         </p>
       </div>
     </div>
@@ -35,8 +35,8 @@
           <div class="learn-links">
             <h4 class="hide-for-small">Want more?</h4>
             <ul>
+              <li><a href="http://foundation.zurb.com/sites">Foundation for Sites</a></li>
               <li><a href="http://foundation.zurb.com/apps">Foundation for Apps</a></li>
-              <li><a href="http://zurb.com/ink/">Ink Responsive Emails</a></li>
               <li><a href="http://zurb.com/notable">Notable Design Apps</a></li>
               <li><a href="http://zurb.com/university/courses">Training</a></li>
               <li><a href="http://zurb.com/library">Design Resources</a></li>