Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 1.25 KB

.verb.md

File metadata and controls

67 lines (48 loc) · 1.25 KB

{%= name %} {%= badge("fury") %}

{%= description %}

Here's a preview

image


Quickstart

{%= include("install-npm", {save: true}) %}

Usage

Register the middleware with Assemble:

options: {
  plugins: ['{%= name %}', 'foo/*.js']
}

Visit the plugins docs for more info or for help getting started.

Add this markup where you want the navigation:

<div id="navigation">
  <!-- navigation -->
</div>

The plugin uses page headings to construct the nav items, results in something like:

<div id="navigation">
  <!-- navigation -->
  <ul class="nav sidenav">
    <li><a href="#collections">Collections</a>
      <ul class="nav">
        <li> <a href="#collections-after">{{after}}</a> </li>
        <li> <a href="#collections-any">{{any}}</a> </li>
        <li> <a href="#collections-before">{{before}}</a> </li>
      </ul>
    </li>
  </ul>
</div>

Other grunt-assemble middleware

{%= related(verb.related.list, {remove: name}) %}

Contributing

{%= include("contributing") %}

Authors

{%= include("author") %}

License

{%= copyright() %} {%= license() %}


{%= include("footer") %}