Skip to content
This repository has been archived by the owner on Feb 18, 2020. It is now read-only.

Commit

Permalink
Documentation Updates:
Browse files Browse the repository at this point in the history
- Added `direction` option to documentation.
- Updated code to use version 1.1 of the plugin.
  • Loading branch information
acolangelo committed Dec 8, 2012
1 parent 0368b8c commit 539f7e5
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 16 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#<a id="docs" href="#docs">jPanelMenu</a>

###Version 1.1

jPanelMenu is a [jQuery](http://jquery.com) plugin that creates a paneled-style menu (like the type seen in the mobile versions of [Facebook](http://m.facebook.com) and [Google](http://google.com), as well as in many native iPhone applications).

Check out the [demo (and documentation) site](http://jpanelmenu.com) to see it in action.
Expand Down Expand Up @@ -101,6 +103,16 @@ Generally, `<style>` and `<script>` tags should not be moved from their original

***

###<a href="#options-direction" id="options-direction">direction</a>

A string specifying which direction the menu should open from.

- **Data Type:** `string`
- **Accepted Values:** `left` or `right`
- **Default Value:** `left`

***

###<a href="#options-openPosition" id="options-openPosition">openPosition</a>

The measurement value for the open position of the menu. Can be set as a pixel, percentage, or `em` value.
Expand Down
2 changes: 1 addition & 1 deletion docs/css/style.css

Large diffs are not rendered by default.

14 changes: 12 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
</head>
<body>
<header class="main">
<h1 class="logo"><a href="#" class="ss-list">jPanelMenu</a></h1>
<h1 class="logo"><a href="." class="ss-list">jPanelMenu</a></h1>
<a href="#menu" class="menu-trigger ss-icon">&#xED50;</a>
<nav>
<ul>
Expand All @@ -40,7 +40,7 @@ <h1 class="logo"><a href="#" class="ss-list">jPanelMenu</a></h1>

<div class="content">
<section class="intro">
<h2 id="overview"><a href="#">Version 1.0</a></h2>
<h2 id="overview"><a href="#">Version 1.1</a></h2>
<div class="text">
<p>jPanelMenu is a <a href="http://jquery.com">jQuery</a> plugin that creates a paneled-style menu (like the type seen in the mobile versions of <a href="http://m.facebook.com">Facebook</a> and <a href="http://google.com">Google</a>, as well as in many native iPhone applications).</p>
<p class="jPM-specific">Just click on the menu button (the top left of this page) to see it in action.</p>
Expand Down Expand Up @@ -144,6 +144,16 @@ <h3><a href="#options-excludedPanelContent">excludedPanelContent</a></h3>
</div>
</div>

<div class="spec" id="options-direction">
<h3><a href="#options-direction">direction</a></h3>
<p>A string specifying which direction the menu should open from.</p>
<div class="details">
<p><strong>Data Type:</strong> <code>string</code></p>
<p><strong>Accepted Values:</strong> <code>left</code> or <code>right</code></p>
<p><strong>Default Value:</strong> <code>left</code></p>
</div>
</div>

<div class="spec" id="options-openPosition">
<h3><a href="#options-openPosition">openPosition</a></h3>
<p>The measurement value for the open position of the menu. Can be set as a pixel, percentage, or <code>em</code> value.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/js/example-jRespond.min.js

Large diffs are not rendered by default.

7 changes: 0 additions & 7 deletions docs/js/lib/jPanelMenu-1.0.0.min.js

This file was deleted.

Loading

0 comments on commit 539f7e5

Please sign in to comment.