Contents

---
title:     Command Line Interface
blurb:     This gem offers a simple command line interface for building its own
           documentation.
layout:    template-logo-medium
---

# <%= current_page.data.title %>
<%= current_page.data.blurb %>

The CLI takes the format:

~~~ bash
middlemac-extras command
~~~

…where the following commands are available.

`documentation`

 : Produces a sample project named `middlemac-extras-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 middlemac-extras-docs
bundle install
bundle exec middleman server
~~~


`help`

 : Displays CLI usage help.
 
`--version` or `-v`

 : Displays the version of `middlemac-extras`.

<% content_for :seeAlso do %>
<ul>
  <li><a href="/">Welcome to <code>middlemac-extras</code></a></li>
  <li><a href="css_image_sizes.html">The <code>css_image_sizes</code> helper</a></li>
  <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="md_links.html">The <code>md_links</code> helper</a></li>
  <li><a href="api_reference.html">API Reference</a></li>
  <li><a href="license.html">The MIT License</a></li>
</ul>
<% end %>

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
middlemac-extras-1.0.11	documentation_project/source/cli.html.md.erb
middlemac-extras-1.0.10	documentation_project/source/cli.html.md.erb
middlemac-extras-1.0.9	documentation_project/source/cli.html.md.erb
middlemac-extras-1.0.8	documentation_project/source/cli.html.md.erb
middlemac-extras-1.0.7	documentation_project/source/cli.html.md.erb