middleman-pagegroups 1.0.2 → 1.0.3

data/documentation_project/source/documentation/80_config.html.md.erb

@@ -96,3 +96,9 @@ end
 
 The block above is taken directly from this project’s `config.rb`. The comments
 in the code above describe the purpose of each setting.
+
+## Configuration Reference
+
+Below is the complete configuration reference.
+
+<%= partial 'partials/yard_config' %>

data/documentation_project/source/documentation/90_cli.html.md.erb

@@ -0,0 +1,47 @@
+---
+title:     Command Line Interface
+id:        cli
+blurb:     <code>middleman-pagegroups</code> has a small CLI.
+layout:    template-logo-medium
+navigator: true
+---
+
+# <%= current_page.data.title %>
+
+`middleman-pagegroups` has a small command line interface that might be useful
+for generating sample documentation or installing the sample partials.
+
+The CLI takes the format:
+
+~~~ bash
+middleman-pagegroups command [options]
+~~~
+
+…where the following commands are available.
+
+`documentation`
+
+ : Produces a sample project named `middleman-pagegroups-docs/` in your current
+   working directory. This sample uses the features of this gem. You can then
+   serve this new project to read the documentation by:
+
+~~~ bash
+cd middleman-pagegroups-docs
+bundle install
+bundle exec middleman server
+~~~
+
+
+`help`
+
+ : Displays CLI usage help.
+ 
+`partials` [_directory_]
+
+ : Produces sample partial files into your current working directory, or into
+   _`directory`_ if you specify one. These partials can then be used using
+   Middleman's `partials` helper in your own projects.
+ 
+`--version` or `-v`
+
+ : Displays the version of `middleman-pagegroups`.

data/documentation_project/source/partials/_yard_config.erb

@@ -0,0 +1,744 @@
+
+
+
+
+  <div id="instance_attr_details" class="attr_details">
+    
+      
+      <span id="options[:extend_page_class]=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="options[:extend_page_class]=-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>options[:extend_page_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>If true then the default <strong>Middleman</strong> <code>page_class</code> helper will be extended
+to include simple <code>group</code> and <code>page_name</code> for each resource.</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[:nav_breadcrumbs_alt_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_breadcrumbs_alt_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_breadcrumbs_alt_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_breadcrumbs_alt</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_breadcrumbs_alt_label]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_breadcrumbs_alt_label]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_breadcrumbs_alt_label]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default “current page” label for the <code>nav_breadcrumbs_alt</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_breadcrumbs_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_breadcrumbs_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_breadcrumbs_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_breadcrumbs</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_brethren_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_brethren_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_brethren_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_brethren</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_brethren_index_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_brethren_index_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_brethren_index_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_brethren_index</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_legitimate_children_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_legitimate_children_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_legitimate_children_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_legitimate_children</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_prev_next_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_prev_next_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_prev_next_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_prev_next</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_prev_next_label_next]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_prev_next_label_next]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_prev_next_label_next]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default “next” label text for the <code>nav_prev_next</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_prev_next_label_prev]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_prev_next_label_prev]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_prev_next_label_prev]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default “previous” label text for the <code>nav_prev_next</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:nav_toc_index_class]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:nav_toc_index_class]=-instance_method">
+  
+    - (<tt>String</tt>) <strong>options[:nav_toc_index_class]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Default css class for the <code>nav_toc_index</code> helper/partial.</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>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>The <code>class</code> attribute value to use for this item’s
+containing element.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns the current value of this option.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:strip_file_prefixes]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:strip_file_prefixes]=-instance_method">
+  
+    - (<tt>Boolean</tt>) <strong>options[:strip_file_prefixes]=</strong>(value) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>If <code>true</code> leading numbers used for sorting files will be removed for
+presentation purposes. This makes it possible to neatly organize your
+source files in their presentation order on your filesystem but output
+nice filenames without ugly prefix numbers.</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>
+
+
+