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.

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

Fixed typos and improved documentation #92

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
57 changes: 27 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,40 @@

![preview](https://raw.github.com/alvarotrigo/pagePiling.js/master/examples/imgs/pagePiling-plugin.png)
![compatibility](https://raw.github.com/alvarotrigo/pagePiling.js/master/examples/imgs/compatible.gif)
Pile your sections one over another and access them scrolling or by URL!

- [Live demo](http://alvarotrigo.com/pagePiling/)
- [Creating hugeinc.com website with pagePiling.js](http://www.onextrapixel.com/2015/04/09/how-to-create-a-beautiful-fullscreen-single-scrolling-page-like-huge-inc/)
- [Who is using it](https://github.com/alvarotrigo/pagePiling.js#who-is-using-pagepilingjs)

Invite me to a coffee
[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=pagePiling%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)

Customizations of the plugin available upon request for some reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
Pile your sections one over another and access them by scrolling, via URL, a navigation, or programatically!

Would you like to have a website using pilePage.js functionality but you don't know how to use it? I can do it for you for a reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
- **[Live demo](http://alvarotrigo.com/pagePiling/)**
- [Resources and tutorials](#resources--tutorials)
- [Who is using pagePiling.js?](#who-is-using-pagepilingjs)

## Introduction
Suggestion are more than welcome, not only for feature requests but also for coding style improvements.
##Introduction
Suggestions are more than welcome, not only for feature requests but also for coding style improvements.
Let's make this a great plugin to make people's lives easier!

## Compatibility
##Compatibility
pagePiling.js is fully functional on all modern browsers, as well as some old ones such as Internet Explorer 8, 9, Opera 12, etc.
It works with browsers with CSS3 support and with the ones which don't have it, making it ideal for old browsers compatibility.

It is also designed to work on touch devices such as mobile phones or tablets.
It is also designed to work on touch devices like smartphones or tablets.

## Usage
##Usage
As you can see in the example files, you will need to include the JavaScript file `jquery.pagepiling.js` (or the minified version `jquery.pagepiling.min.js`) and the css file `jquery.pagepiling.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.

### Install using bower:
Optionally, you can install pagePiling.js with bower:
Terminal:
```shell
bower install pagepiling.js
```

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

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script type="text/javascript" src="jquery.pagepiling.js"></script>
<script src="https://code.jquery.com/jquery-2.2.3.min.js"></script>
<script src="jquery.pagepiling.js"></script>
```

###Install using Bower
Optionally, you can install pagePiling.js using Bower:
Terminal:
```shell
bower install pagepiling.js
```

###Required HTML structure
Expand Down Expand Up @@ -99,7 +94,7 @@ $(document).ready(function() {
});
```

### Accesing sections
### Accessing sections
In order to create links to a certain section, you can use a normal URL link if you are using pagePiling.js with anchor links (using the `anchors` option), then you will be able to use anchor links also to navigate directly to a certain section.
For example: http://alvarotrigo.com/pagePiling/#page2

Expand All @@ -115,7 +110,7 @@ In case you want to have a section with large content and therefore create an sc
<div class="section pp-scrollable"></div>
```

## Options
##Options

- `verticalCentered`: (default `true`) Vertically centering of the content within sections.

Expand Down Expand Up @@ -301,9 +296,10 @@ Example:
});
```

## Resources
##Resources & Tutorials

[CSS Easing Animation Tool - Matthew Lein](http://matthewlein.com/ceaser/)
- [CSS Easing Animation Tool - Matthew Lein](http://matthewlein.com/ceaser/)
- [Creating hugeinc.com website with pagePiling.js](http://www.onextrapixel.com/2015/04/09/how-to-create-a-beautiful-fullscreen-single-scrolling-page-like-huge-inc/)


## Who is using pagePiling.js
Expand All @@ -321,11 +317,12 @@ If you want your page to be listed here. Please <a href="mailto:alvaro@alvarotri
- http://aungthurhahein.me/
- http://mannydesigns.co

## Donations
Donations would be more than welcome :)
#### Love pagePiling.js?
##### Buy me a coffee!

[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=pagePiling%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)

Want a website with pagePiling.js but you don't know how? Need a custom build? <a href="http://alvarotrigo.com/#contact-page">Hire me</a>!

## License

Expand Down
2 changes: 1 addition & 1 deletion examples/backgrounds.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Expand Down
2 changes: 1 addition & 1 deletion examples/demoPage.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Expand Down
4 changes: 2 additions & 2 deletions examples/horizontalScroll.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Expand Down Expand Up @@ -27,7 +27,7 @@
sectionsColor: ['white', '#ee005a', '#2C3E50', '#39C'],
navigation: {
'position': 'right',
'tooltips': ['Page 1', 'Page 2', 'Page 3', 'Pgae 4']
'tooltips': ['Page 1', 'Page 2', 'Page 3', 'Page 4']
},
afterRender: function(){
$('#pp-nav').addClass('custom');
Expand Down
4 changes: 2 additions & 2 deletions examples/noAnchors.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Expand All @@ -22,7 +22,7 @@
sectionsColor: ['#bfda00', '#2ebe21', '#2C3E50', '#51bec4'],
navigation: {
'position': 'right',
'tooltips': ['Page 1', 'Page 2', 'Page 3', 'Pgae 4']
'tooltips': ['Page 1', 'Page 2', 'Page 3', 'Page 4']
}
});
});
Expand Down
4 changes: 2 additions & 2 deletions examples/scrollingSpeed.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<html>

<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
Expand All @@ -24,7 +24,7 @@
sectionsColor: ['#bfda00', '#2ebe21', '#2C3E50', '#51bec4'],
navigation: {
'position': 'right',
'tooltips': ['Page 1', 'Page 2', 'Page 3', 'Pgae 4']
'tooltips': ['Page 1', 'Page 2', 'Page 3', 'Page 4']
}
});
});
Expand Down