Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken headings in Markdown files #92

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix broken headings in Markdown files #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ It is designed to work as well on touch devices such as mobile phones or tablets
## Usage
As you can see in the example files, you will need to include the JavaScript file `jquery.multiscroll.js` (or the minified version `jquery.multiscroll.min.js`) and the css file `jquery.multiscroll.css` of the plugin, as well as [jQuery](http://jquery.com/). Optionally, you can add the [jQuery UI library](http://jqueryui.com/) in case you want to use other easing effects apart from the ones included in the jQuery library which are the `linear` or `swing` effects. (`easeInQuart` is active by default, so you would need [jQuery UI library](http://jqueryui.com/) or the customized version which is included in the vendors folder under the name `jquery.easings.min.js`.)

###Including files:
### Including files:
```html
<link rel="stylesheet" type="text/css" href="jquery.multiscroll.css" />

Expand All @@ -42,7 +42,7 @@ As you can see in the example files, you will need to include the JavaScript fil
<script type="text/javascript" src="jquery.multiscroll.js"></script>
```

###Required HTML structure
### Required HTML structure
Each section will be defined with a `div` containing the `section` class.
The active section by default will be the first section, which is taken as the home page.
```html
Expand All @@ -67,7 +67,7 @@ This should be done for the `ms-right` and `ms-left` elements.
<div class="ms-section active">Some section</div>
```

###Initialization
### Initialization
All you need to do is call the plugin inside a `$(document).ready` function:

```javascript
Expand Down Expand Up @@ -244,7 +244,7 @@ $.fn.multiscroll.build();


## Callbacks
###afterLoad (`anchorLink`, `index`)
### afterLoad (`anchorLink`, `index`)
Callback fired once the sections have been loaded, after the scrolling has ended.
Parameters:

Expand Down Expand Up @@ -273,7 +273,7 @@ Example:
});
```

###onLeave (`index`, `nextIndex`, `direction`)
### onLeave (`index`, `nextIndex`, `direction`)
This callback is fired once the user leaves a section, in the transition to the new section.

Parameters:
Expand All @@ -300,7 +300,7 @@ Example:
```


###afterRender()
### afterRender()
This callback is fired just after the structure of the page is generated. This is the callback you want to use to initialize other plugins or fire any code which requires the document to be ready (as this plugin modifies the DOM to create the resulting structure).

Example:
Expand All @@ -313,7 +313,7 @@ Example:
});
```

###afterResize()
### afterResize()
This callback is fired after resizing the browser's window. Just after the sections are resized.

Example:
Expand Down