middleman-targets 1.0.0

data/documentation_project/source/stylesheets/_normalize.scss

@@ -0,0 +1,374 @@
+/*! normalize.css v2.0.1 | MIT License | git.io/normalize */
+
+/* ==========================================================================
+   HTML5 display definitions
+   ========================================================================== */
+
+/*
+ * Corrects `block` display not defined in IE 8/9.
+ */
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+nav,
+section,
+summary {
+    display: block;
+}
+
+/*
+ * Corrects `inline-block` display not defined in IE 8/9.
+ */
+
+audio,
+canvas,
+video {
+    display: inline-block;
+}
+
+/*
+ * Prevents modern browsers from displaying `audio` without controls.
+ * Remove excess height in iOS 5 devices.
+ */
+
+audio:not([controls]) {
+    display: none;
+    height: 0;
+}
+
+/*
+ * Addresses styling for `hidden` attribute not present in IE 8/9.
+ */
+
+[hidden] {
+    display: none;
+}
+
+/* ==========================================================================
+   Base
+   ========================================================================== */
+
+/*
+ * 1. Sets default font family to sans-serif.
+ * 2. Prevents iOS text size adjust after orientation change, without disabling
+ *    user zoom.
+ */
+
+html {
+    font-family: sans-serif; /* 1 */
+    -webkit-text-size-adjust: 100%; /* 2 */
+    -ms-text-size-adjust: 100%; /* 2 */
+}
+
+/*
+ * Removes default margin.
+ */
+
+body {
+    margin: 0;
+}
+
+/* ==========================================================================
+   Links
+   ========================================================================== */
+
+/*
+ * Addresses `outline` inconsistency between Chrome and other browsers.
+ */
+
+a:focus {
+    outline: thin dotted;
+}
+
+/*
+ * Improves readability when focused and also mouse hovered in all browsers.
+ */
+
+a:active,
+a:hover {
+    outline: 0;
+}
+
+/* ==========================================================================
+   Typography
+   ========================================================================== */
+
+/*
+ * Addresses `h1` font sizes within `section` and `article` in Firefox 4+,
+ * Safari 5, and Chrome.
+ */
+
+h1 {
+    font-size: 2em;
+}
+
+/*
+ * Addresses styling not present in IE 8/9, Safari 5, and Chrome.
+ */
+
+abbr[title] {
+    border-bottom: 1px dotted;
+}
+
+/*
+ * Addresses style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
+ */
+
+b,
+strong {
+    font-weight: bold;
+}
+
+/*
+ * Addresses styling not present in Safari 5 and Chrome.
+ */
+
+dfn {
+    font-style: italic;
+}
+
+/*
+ * Addresses styling not present in IE 8/9.
+ */
+
+mark {
+    background: #ff0;
+    color: #000;
+}
+
+
+/*
+ * Corrects font family set oddly in Safari 5 and Chrome.
+ */
+
+code,
+kbd,
+pre,
+samp {
+    font-family: monospace, serif;
+    font-size: 1em;
+}
+
+/*
+ * Improves readability of pre-formatted text in all browsers.
+ */
+
+pre {
+    white-space: pre;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+}
+
+/*
+ * Sets consistent quote types.
+ */
+
+q {
+    quotes: "\201C" "\201D" "\2018" "\2019";
+}
+
+/*
+ * Addresses inconsistent and variable font size in all browsers.
+ */
+
+small {
+    font-size: 80%;
+}
+
+/*
+ * Prevents `sub` and `sup` affecting `line-height` in all browsers.
+ */
+
+sub,
+sup {
+    font-size: 75%;
+    line-height: 0;
+    position: relative;
+    vertical-align: baseline;
+}
+
+sup {
+    top: -0.5em;
+}
+
+sub {
+    bottom: -0.25em;
+}
+
+/* ==========================================================================
+   Embedded content
+   ========================================================================== */
+
+/*
+ * Removes border when inside `a` element in IE 8/9.
+ */
+
+img {
+    border: 0;
+}
+
+/*
+ * Corrects overflow displayed oddly in IE 9.
+ */
+
+svg:not(:root) {
+    overflow: hidden;
+}
+
+/* ==========================================================================
+   Figures
+   ========================================================================== */
+
+/*
+ * Addresses margin not present in IE 8/9 and Safari 5.
+ */
+
+figure {
+    margin: 0;
+}
+
+/* ==========================================================================
+   Forms
+   ========================================================================== */
+
+/*
+ * Define consistent border, margin, and padding.
+ */
+
+fieldset {
+    border: 1px solid #c0c0c0;
+    margin: 0 2px;
+    padding: 0.35em 0.625em 0.75em;
+}
+
+/*
+ * 1. Corrects color not being inherited in IE 8/9.
+ * 2. Remove padding so people aren't caught out if they zero out fieldsets.
+ */
+
+legend {
+    border: 0; /* 1 */
+    padding: 0; /* 2 */
+}
+
+/*
+ * 1. Corrects font family not being inherited in all browsers.
+ * 2. Corrects font size not being inherited in all browsers.
+ * 3. Addresses margins set differently in Firefox 4+, Safari 5, and Chrome
+ */
+
+button,
+input,
+select,
+textarea {
+    font-family: inherit; /* 1 */
+    font-size: 100%; /* 2 */
+    margin: 0; /* 3 */
+}
+
+/*
+ * Addresses Firefox 4+ setting `line-height` on `input` using `!important` in
+ * the UA stylesheet.
+ */
+
+button,
+input {
+    line-height: normal;
+}
+
+/*
+ * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
+ *    and `video` controls.
+ * 2. Corrects inability to style clickable `input` types in iOS.
+ * 3. Improves usability and consistency of cursor style between image-type
+ *    `input` and others.
+ */
+
+button,
+html input[type="button"], /* 1 */
+input[type="reset"],
+input[type="submit"] {
+    -webkit-appearance: button; /* 2 */
+    cursor: pointer; /* 3 */
+}
+
+/*
+ * Re-set default cursor for disabled elements.
+ */
+
+button[disabled],
+input[disabled] {
+    cursor: default;
+}
+
+/*
+ * 1. Addresses box sizing set to `content-box` in IE 8/9.
+ * 2. Removes excess padding in IE 8/9.
+ */
+
+input[type="checkbox"],
+input[type="radio"] {
+    box-sizing: border-box; /* 1 */
+    padding: 0; /* 2 */
+}
+
+/*
+ * 1. Addresses `appearance` set to `searchfield` in Safari 5 and Chrome.
+ * 2. Addresses `box-sizing` set to `border-box` in Safari 5 and Chrome
+ *    (include `-moz` to future-proof).
+ */
+
+input[type="search"] {
+    -webkit-appearance: textfield; /* 1 */
+    -moz-box-sizing: content-box;
+    -webkit-box-sizing: content-box; /* 2 */
+    box-sizing: content-box;
+}
+
+/*
+ * Removes inner padding and search cancel button in Safari 5 and Chrome
+ * on OS X.
+ */
+
+input[type="search"]::-webkit-search-cancel-button,
+input[type="search"]::-webkit-search-decoration {
+    -webkit-appearance: none;
+}
+
+/*
+ * Removes inner padding and border in Firefox 4+.
+ */
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+    border: 0;
+    padding: 0;
+}
+
+/*
+ * 1. Removes default vertical scrollbar in IE 8/9.
+ * 2. Improves readability and alignment in all browsers.
+ */
+
+textarea {
+    overflow: auto; /* 1 */
+    vertical-align: top; /* 2 */
+}
+
+/* ==========================================================================
+   Tables
+   ========================================================================== */
+
+/*
+ * Remove most spacing between table cells.
+ */
+
+table {
+    border-collapse: collapse;
+    border-spacing: 0;
+}

data/documentation_project/source/stylesheets/style.css.scss

@@ -0,0 +1,3 @@
+@import "normalize";              // keep normalize in case deployment to non Help Center.
+@import "middlemac_minimal";      // basic styles.
+@import "github";                 // styles used for code blocks.

data/documentation_project/source/target-feature-config.html.md.erb

@@ -0,0 +1,153 @@
+---
+title:  Configuration
+layout: template-logo-medium
+---
+
+# Configuration
+
+Configuring `middleman-targets` is done in the standard Middleman `config.rb`
+file using a few simple options that are added to Middleman.
+
+If you’re used to most Middleman extensions you may be familiar with setting
+extension options in a `do` block when activating the extension. Please note
+that `middleman-targets` extends Middleman itself; the new options must _not_
+be specified in the activation block!
+{:.note}
+
+## Activation
+
+As with most Middleman extensions, `middleman-targets` must be activated before
+use. Simply add
+
+~~~ ruby
+activate :MiddlemanTargets
+~~~
+
+to your `config.rb` file.
+
+### Activation Conflicts
+
+`middleman-targets` enhances the `image_tag` helper, and as such it expects to
+be able to inherit from other `image_tag` helpers in order to do its job
+completely. If you use other extensions that enhance the `image_tag` helper,
+such as `automatic_image_sizes` or `automatic_alt_tags`, ensure that you 
+activate them _before_ activating `middleman-targets`.
+
+## The Configuration Options
+
+`target`
+
+  : This is the target that is used automatically when you `middleman build` 
+    or `middleman server` without using the `--targets` option from the
+    command line.
+
+`targets`
+
+  : The `targets` key is a comprehensive list of your targets, their features,
+    and other data pertinent to your targets.
+  
+    All of the keys contained in this structure are described in the next
+    section, below.
+
+`target_magic_images`
+`target_magic_word`
+
+  : By enabling `target_magic_images` and using `middleman-targets`’ image
+    helper, target specific images will be used instead of the image you 
+    specify, *if* that image name is prefixed with `target_magic_word`. For
+    example, you might request `all-my_image.png`, and `pro-my_image.png` (if it
+    exists) will be used in your :pro target instead.
+    
+    Important: when this is enabled, images from *other* targets will *not* be
+    included in the build! In the example above, *any* image prefixed with 
+    `free-` would not be included in the output directory.
+  
+`build_dir`
+
+  : Build output will use this directory as a *prefix*; if the target
+    is `:pro`, then the actual build directory will be `build (pro)/`. If the
+    `build_dir` key is present for any of the `targets`, they will override this
+    setting.
+    
+## The `targets` key by example
+
+The code below is the actual `targets` key for this sample project. We’ll look
+at the sub-keys and their values to understand how targets and features are
+defined, and how you can effect your build output directory as well as add
+other arbitrary data to each target.
+
+~~~ ruby
+set :targets, {
+  :free =>
+      {
+      :sample_key => 'People who use free versions don\'t drive profits.',
+      :build_dir  => 'build (%s)',
+      :features   =>
+          {
+          :feature_advertise_pro => true,
+          :insults_user          => true,
+          :grants_wishes         => false,
+          }
+      },
+
+  :pro =>
+      {
+      :sample_key => 'You are a valued contributor to our balance sheet!',
+      :features =>
+          {
+          :feature_advertise_pro => false,
+          :insults_user          => false,
+          :grants_wishes         => true,
+          }
+      },
+}
+~~~
+    
+### Each `targets`
+
+Looking at the top level of this structure you can see that there are two
+targets defined: `free` and `pro`. Nested within each of them are a series of
+additional keys.
+
+`sample_key`
+
+ : This is an example data key associated with each target. You can specify as
+   many as you wish using any naming convention that suits you. Target-specific
+   values can be retrieved in your pages using the `target_value`
+   [helper](helpers-resources.html).
+   
+`build_dir`
+
+ : When used for a target then this specified directory overrides the Middleman
+   `build_dir` setting. Note that in this project only the `free` target
+   specifies a `build_dir`; it is optional. The `pro` target, lacking a
+   `build_dir` key will default to the `middleman-targets` option setting.
+   
+   You can use a specific string for this setting, or optionally you can include
+   a single `%s` **sprintf** placeholder which will be filled with the target
+   name during build, as shown in this example.
+   
+`features`
+
+ : This key is where you define the features that are pertinent to each of your
+   targets, as well as enable or disable them.
+   
+   You can add as many features as you like, and the names can be any valid
+   Ruby symbol.
+   
+   Although not precisely required, it’s an excellent best practice to add
+   _every_ feature to _all_ of your targets, as is done in this sample project.
+   They can be enabled and disabled simply by toggling their values between
+   `true` and `false`.
+
+  
+
+<% content_for :seeAlso do %>
+<ul>
+<li><a href="index.html">Welcome to middleman-targets</a></li>
+<li><a href="simple-demo.html">Simple features demonstration</a></li>
+<li><a href="build-serve-targets.html">Build and Serve different targets</a></li>
+<li><a href="helpers-resources.html">Helpers and Resources</a></li>
+<li><a href="frontmatter.html">Front Matter</a></li>
+</ul>
+<% end %>