From 90c093dead16981944e8782c04362fdd785f3389 Mon Sep 17 00:00:00 2001 From: Olivier Lacan Date: Mon, 17 Apr 2017 14:57:42 +0200 Subject: [PATCH] Fix your Markdown, friend :-) Also get that changelog out this readme :-p --- README.md | 112 +++++++++++++++++++++++++++--------------------------- 1 file changed, 56 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index fa11681..20f995e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -#jPanelMenu +# jPanelMenu -###Version 1.4.1 +### Version 1.4.1 jPanelMenu is a [jQuery](http://jquery.com) plugin for easily creating and managing off-canvas content. @@ -10,7 +10,7 @@ Check out the [changelog](#changelog) to see what’s new. -#How Do I Use This Thing? +# How Do I Use This Thing? Start off by including the jPanelMenu.js file in your page. (Bonus points for using the minified version [jPanelMenu.min.js], or for bundling the jPanelMenu code into your own JavaScript file to reduce size and HTTP requests.) @@ -37,7 +37,7 @@ If you want to take things to the next level, keep reading. -#How Does This Thing Work? +# How Does This Thing Work? When jPanelMenu is [turned on](#api-on), two `
` elements are created. The menu element (with an ID of `jPanelMenu-menu`), and the panel element (with a class of `jPanelMenu-panel`). In addition, a class of `jPanelMenu` is applied to the `` tag. @@ -53,7 +53,7 @@ When jPanelMenu is [turned off](#api-off), the two `
` elements are removed, -#Does It Animate? +# Does It Animate? Of course! (If you want it to, there’s an [option](#options) for that.) @@ -63,7 +63,7 @@ For browsers that do not support CSS transitions, the jQuery animation engine is -#Options +# Options The following options are set via an `object` passed into the constructor function call, as shown below. @@ -75,7 +75,7 @@ The following options are set via an `object` passed into the constructor functi *** -###menu +### menu A selector string pointing to the desired menu element. @@ -84,7 +84,7 @@ A selector string pointing to the desired menu element. *** -###panel +### panel A selector string pointing to the desired root panel element. Point this to the element containing all content that should go into the panel. @@ -93,7 +93,7 @@ A selector string pointing to the desired root panel element. Point this to the *** -###trigger +### trigger A selector string pointing to the menu-triggering element. @@ -102,7 +102,7 @@ A selector string pointing to the menu-triggering element. *** -###excludedPanelContent +### excludedPanelContent A selector string specifying which elements within the `` element should **not** be pushed into `.jPanelMenu-panel`. The selector string may contain any selector, not just tags. @@ -113,7 +113,7 @@ Generally, `