middlemac-extras 1.0.6 → 1.0.11

data/documentation_project/source/css_image_sizes.html.md.erb

@@ -4,8 +4,6 @@ blurb:    Use the <code>css_image_sizes</code> helper to specify maximum sizes
           for all of your project’s images without using unsemantic width and 
           height attributes in your HTML code.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -16,6 +14,7 @@ navigate: false
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
@@ -45,7 +44,7 @@ When called like this:
 
 You could use this in an HTML `<style>` element on each of your pages, or better
 yet in your layouts. This has the unfortunate effect of including it in every
-one of your pages, however, and so this sample project uses like this:
+one of your pages, however, and so this sample project uses it like this:
 
 Contents of `stylesheets/css_image_sizes.css.erb`:
 

data/documentation_project/source/image_tag.html.md.erb

@@ -3,8 +3,6 @@ title:    The <code>image_tag</code> helper
 blurb:    Find out how to use the enhanced <code>image_tag</code> helper so that
           it can be even more helpful.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -15,6 +13,7 @@ navigate: false
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>

data/documentation_project/source/index.html.md.erb

@@ -2,7 +2,6 @@
 title:    Welcome to <code>middlemac-extras</code>
 blurb:    <em>middlemac-extras</em> adds several developer conveniences.
 layout:   template-logo-large
-navigate: false
 ---
 
 <%= md_links %>
@@ -10,12 +9,10 @@ navigate: false
 # <%= current_page.data.title %>
 
 Although developed for **Middlemac**, the `middlemac-extras` extension for
-Middleman is a great way to add handy developer conveniences to your Middleman
-project.
-
-It serves as a truly “extra” extension that gathers utilities intended for
-**MiddleMac** but are generic enough that they can be used with any Middleman
-project.
+**Middleman** is a great way to add handy developer conveniences to your
+**Middleman** project. It serves as a truly “extra” extension that gathers
+utilities intended for **MiddleMac** but are generic enough that they can be
+used with any **Middleman** project.
 
 This extension currently offers features such as these:
 
@@ -48,6 +45,10 @@ This extension currently offers features such as these:
 
 [Setting up `config.rb`][config_rb]
  : Review the key configuration values for making this extension work.
+
+[API Reference][api_reference]
+ : Look at the API documentation for the helpers and configuration settings
+   directly.
  
 [Command Line Interface][cli]
  : This gem offers a simple command line interface for building its own

data/documentation_project/source/license.html.md.erb

@@ -2,8 +2,6 @@
 title:    The MIT License
 blurb:    Describes your legal rights and obligations for using these materials.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -15,6 +13,7 @@ navigate: false
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
 </ul>
 <% end %>

data/documentation_project/source/md_images.html.md.erb

@@ -3,8 +3,6 @@ title:    The <code>md_images</code> helper
 blurb:    Automatic Markdown reference style links for every image in your site
           are available by using this helper.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -16,6 +14,7 @@ navigate: false
   <li><a href="image_tag.html">The <code>image_tag</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>

data/documentation_project/source/md_links.html.md.erb

@@ -4,8 +4,6 @@ blurb:    The <code>md_links</code> helper can help you by providing Markdown
           reference-style links (including title attributes) to every page in
           your site.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -16,6 +14,7 @@ navigate: false
   <li><a href="image_tag.html">The <code>image_tag</code> helper</a></li>
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>

data/documentation_project/source/partials/_yard_config.erb

@@ -0,0 +1,200 @@
+
+
+
+
+  <div id="instance_attr_details" class="attr_details">
+    
+      
+      <span id="options[:img_auto_extensions]=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="options[:img_auto_extensions]=-instance_method">
+  
+    #<strong>options[:img_auto_extensions]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not to support specifying images without
+using a file name extension. If set to <code>true</code> then the <code>image_tag</code> helper
+will work for images even if you don’t specify an extension, but only if a
+file exists on disk that has one of the extensions in 
+<code>:img_auto_extensions_order</code>.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:img_auto_extensions_order]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:img_auto_extensions_order]=-instance_method">
+  
+    #<strong>options[:img_auto_extensions_order]=</strong>(value)  &#x21d2; <tt>Array&lt;String&gt;</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option defines the eligible file name extensions and their precedence
+when you specify an image without an extension using the <code>image_tag</code> helper.
+Set this to an array of image file extensions in your desired order of
+of precedence.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Set to an array of image extensions.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:retina_srcset]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:retina_srcset]=-instance_method">
+  
+    #<strong>options[:retina_srcset]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This option determines whether or not the enhanced <code>image_tag</code> helper will
+be used to include an @2x <code>srcset</code> attribute automatically. This automatic
+behavior will only be applied if the image asset exists on disk and this
+option is set to <code>true</code>.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>value</span>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this feature.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+  </div>
+
+
+

data/documentation_project/source/partials/_yard_helpers.erb

@@ -0,0 +1,192 @@
+
+
+
+
+
+  <div class="method_details_list">
+    
+    
+      
+        <div class="method_details first">
+  <h3 class="signature first" id="css_image_sizes-instance_method">
+  
+    #<strong>css_image_sizes</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides CSS for every image in your
+project. Each image will have a declaration that sets
+<code>max-width</code> and <code>max-height</code> to the actual size of the
+image. Proper @2x image support is included. It’s most
+useful to use this helper in a <code>some_file.css.erb</code>
+file.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the CSS markup
+for every image found in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+        <div class="method_details ">
+  <h3 class="signature " id="md_hblinks-instance_method">
+  
+    #<strong>md_hblinks</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides access to <code>middlemac-extras</code>’ 
+index of links in Markdown reference format, enabling
+you to use reference-style links in documents. Because
+this helper includes literal Markdown, it’s only useful
+in Markdown documents. This is only useful when using
+Middlemac 3.0.0 or newer, which includes support for
+helpbook style links.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the Markdown
+index of every page in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+        <div class="method_details ">
+  <h3 class="signature " id="md_images-instance_method">
+  
+    #<strong>md_images</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides access to <code>middlemac-extras</code>’ 
+index of images in Markdown reference format, enabling
+you to use reference-style images in documents. Because
+this helper includes literal Markdown, it’s only useful
+in Markdown documents.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the Markdown
+index of every image in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+        <div class="method_details ">
+  <h3 class="signature " id="md_links-instance_method">
+  
+    #<strong>md_links</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides access to <code>middlemac-extras</code>’ 
+index of links in Markdown reference format, enabling
+you to use reference-style links in documents. Because
+this helper includes literal Markdown, it’s only useful
+in Markdown documents.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the Markdown
+index of every page in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+      
+    
+  </div>
+
+