Skip to content

Commit 5843cf3

Browse files
alvarotrigoalvarotrigo
authored
Merge pull request alvarotrigo#2620 from alvarotrigo/dev
- Documentation aesthetics changes
2 parents c2d3fb5 + 6d88f75 commit 5843cf3

File tree

2 files changed

+68
-52
lines changed

2 files changed

+68
-52
lines changed

‎README.md

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,26 @@
55
<p align="center">
66
<a href="https://github.com/alvarotrigo/fullPage.js"><img src="https://raw.githubusercontent.com/alvarotrigo/fullPage.js/dev/examples/imgs/en-language.png" /></a><a href="https://github.com/alvarotrigo/fullPage.js/blob/dev/README_SPANISH.md#fullpagejs"><img src="https://raw.githubusercontent.com/alvarotrigo/fullPage.js/dev/examples/imgs/es-language-inactive.png" /></a>
77
</p>
8+
9+
---
10+
811
![fullPage.js version](http://img.shields.io/badge/fullPage.js-v2.9.4-brightgreen.svg)
912
[![License](http://img.shields.io/badge/License-MIT-blue.svg)](http://opensource.org/licenses/MIT)
1013
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/alvarotrigo/9.95)
1114
&nbsp;&nbsp; **|**&nbsp;&nbsp; *7Kb gziped* &nbsp;&nbsp;**|**&nbsp;&nbsp; *Created by [@imac2](https://twitter.com/imac2)*
1215

13-
A simple and easy to use libary to create fullscreen scrolling websites (also known as single page websites or onepage sites).
14-
It allows the creation of fullscreen scrolling websites, as well as adding some landscape sliders inside the sections of the site.
15-
1616
- [Live demo](http://alvarotrigo.com/fullPage/)
17-
- [Wordpress theme](http://alvarotrigo.com/fullPage/utils/wordpress.html)
17+
- [Wordpress theme](http://alvarotrigo.com/fullPage/utils/wordpress-y-theme.html)
1818
- [fullpage.js Extensions](http://alvarotrigo.com/fullPage/extensions/)
1919
- [Frequently Answered Questions](https://github.com/alvarotrigo/fullPage.js/wiki/FAQ---Frequently-Answered-Questions)
2020

21+
[![Wordpress Y-Theme](http://wallpapers-for-ipad.com/fullpage/imgs3/banner.png)](http://alvarotrigo.com/fullPage/utils/wordpress-y-theme.html)
22+
23+
---
24+
25+
A simple and easy to use libary to create fullscreen scrolling websites (also known as single page websites or onepage sites).
26+
It allows the creation of fullscreen scrolling websites, as well as adding some landscape sliders inside the sections of the site.
27+
2128
Invite me to a coffee
2229
[![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=fullPage%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
2330

@@ -77,7 +84,7 @@ bower install fullpage.js
7784
npm install fullpage.js
7885
```
7986

80-
###Including files:
87+
### Including files:
8188
```html
8289
<link rel="stylesheet" type="text/css" href="jquery.fullPage.css" />
8390

@@ -93,11 +100,11 @@ npm install fullpage.js
93100
<script type="text/javascript" src="jquery.fullPage.js"></script>
94101
```
95102

96-
###Optional use of CDN
103+
### Optional use of CDN
97104
If you prefer to use a CDN to load the needed files, fullPage.js is in CDNJS:
98105
https://cdnjs.com/libraries/fullPage.js
99106

100-
###Required HTML structure
107+
### Required HTML structure
101108
Start your HTML document with the compulsory [HTML DOCTYPE declaration](http://www.corelangs.com/html/introduction/doctype.html) on the 1st line of your HTML code. You might have troubles with sections heights otherwise. The examples provided use HTML 5 doctype `<!DOCTYPE html>`.
102109

103110
Each section will be defined with an element containing the `section` class.
@@ -128,7 +135,7 @@ In order to create a landscape slider within a section, each slide will be defin
128135
````
129136
You can see a fully working example of the HTML structure in the [`demoPage.html` file](https://github.com/alvarotrigo/fullPage.js/blob/master/examples/demoPage.html).
130137

131-
###Initialization
138+
### Initialization
132139
All you need to do is call fullPage.js inside a `$(document).ready` function:
133140

134141
```javascript
@@ -275,7 +282,7 @@ Fullpage.js adds multiple classes in different elements to keep a record of the
275282
- `fp-destroyed` is added to the fullpage.js container when fullPage.js is destroyed.
276283
- `fp-enabled` is added to the `html` element once the libary is initalized.
277284

278-
###Lazy Loading
285+
### Lazy Loading
279286
[Demo](http://codepen.io/alvarotrigo/pen/eNLBXo) fullPage.js provides a way to lazy load images, videos and audio elements so they won't slow down the loading of your site or unnecessarily waste data transfer.
280287
When using lazy loading, all these elements will only get loaded when entering in the viewport.
281288
To enable lazy loading all you need to do is change your `src` attribute to `data-src` as shown below:
@@ -290,7 +297,7 @@ To enable lazy loading all you need to do is change your `src` attribute to `dat
290297

291298
If you already use another lazy load solution which uses `data-src` as well, you can disable the fullPage.js lazy loading by setting the option `lazyLoading: false`.
292299

293-
###Auto play/pause embedded media
300+
### Auto play/pause embedded media
294301

295302
**Note**: the autoplay feature might not work on some mobile devices depending on the OS and browser (i.e. [Safari on iOS](https://webkit.org/blog/6784/new-video-policies-for-ios/) version < 10.0).
296303

@@ -312,7 +319,7 @@ Embedded HTML5 `<video>` / `<audio>` and Youtube iframes are automatically paus
312319
</audio>
313320
```
314321

315-
###Use extensions
322+
### Use extensions
316323
fullpage.js [provides a set of extensions](http://alvarotrigo.com/fullPage/extensions/) you can use to enhance its default features. All of them are listed as [fullpage.js options](https://github.com/alvarotrigo/fullPage.js#options).
317324

318325
Extensions requires you to use the minified file [`jquery.fullpage.extensions.min.js`](https://github.com/alvarotrigo/fullPage.js/blob/master/dist/jquery.fullpage.extensions.min.js) that is inside the [`dist` folder](https://github.com/alvarotrigo/fullPage.js/tree/master/dist) instead of the usual fullPage.js file (`jquery.fullpage.js` or `jquery.fullpage.min.js`).
@@ -656,7 +663,7 @@ $.fn.fullpage.responsiveSlides.toSlides();
656663
## Callbacks
657664
[Demo](http://codepen.io/alvarotrigo/pen/XbPNQv) You can see them in action [here](http://alvarotrigo.com/fullPage/examples/callbacks.html).
658665

659-
###afterLoad (`anchorLink`, `index`)
666+
### afterLoad (`anchorLink`, `index`)
660667
Callback fired once the sections have been loaded, after the scrolling has ended.
661668
Parameters:
662669

@@ -687,7 +694,7 @@ Example:
687694
});
688695
```
689696
---
690-
###onLeave (`index`, `nextIndex`, `direction`)
697+
### onLeave (`index`, `nextIndex`, `direction`)
691698
This callback is fired once the user leaves a section, in the transition to the new section.
692699
Returning `false` will cancel the move before it takes place.
693700

@@ -716,7 +723,7 @@ Example:
716723
});
717724
```
718725

719-
####Cancelling the scroll before it takes place
726+
#### Cancelling the scroll before it takes place
720727
You can cancel the scroll by returning `false` on the `onLeave` callback:
721728

722729
```javascript
@@ -731,7 +738,7 @@ You can cancel the scroll by returning `false` on the `onLeave` callback:
731738
```
732739

733740
---
734-
###afterRender()
741+
### afterRender()
735742
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). See [FAQs](https://github.com/alvarotrigo/fullPage.js/wiki/FAQ---Frequently-Answered-Questions) for more info.
736743

737744
Example:
@@ -745,7 +752,7 @@ Example:
745752
});
746753
```
747754
---
748-
###afterResize()
755+
### afterResize()
749756
This callback is fired after resizing the browser's window. Just after the sections are resized.
750757

751758
Example:
@@ -759,7 +766,7 @@ Example:
759766
});
760767
```
761768
---
762-
###afterResponsive(`isResponsive`)
769+
### afterResponsive(`isResponsive`)
763770
This callback is fired after fullpage.js changes from normal to responsive mode or from responsive mode to normal mode.
764771

765772
Parameters:
@@ -776,7 +783,7 @@ Example:
776783
});
777784
```
778785
---
779-
###afterSlideLoad (`anchorLink`, `index`, `slideAnchor`, `slideIndex`)
786+
### afterSlideLoad (`anchorLink`, `index`, `slideAnchor`, `slideIndex`)
780787
Callback fired once the slide of a section have been loaded, after the scrolling has ended.
781788
Parameters:
782789

@@ -811,7 +818,7 @@ Example:
811818

812819

813820
---
814-
###onSlideLeave (`anchorLink`, `index`, `slideIndex`, `direction`, `nextSlideIndex`)
821+
### onSlideLeave (`anchorLink`, `index`, `slideIndex`, `direction`, `nextSlideIndex`)
815822
This callback is fired once the user leaves an slide to go to another, in the transition to the new slide.
816823
Returning `false` will cancel the move before it takes place.
817824

@@ -844,26 +851,27 @@ Example:
844851
});
845852
```
846853

847-
####Cancelling a move before it takes place
854+
#### Cancelling a move before it takes place
848855
You can cancel a move by returning `false` on the `onSlideLeave` callback. [Same as when canceling a movement with `onLeave`](https://github.com/alvarotrigo/fullPage.js#cancelling-the-scroll-before-it-takes-place).
849856

850-
#Reporting issues
857+
# Reporting issues
851858
1. Please, look for your issue before asking using the github issues search.
852859
2. Make sure you use the latest fullpage.js version. No support is provided for older versions.
853860
3. Use the [the Github Issues forum](https://github.com/alvarotrigo/fullPage.js/issues) to create issues.
854861
4. **An isolated reproduction of the issue will be required.** Make use of [jsfiddle](http://jsfiddle.net/97tbk/418/) or [codepen](http://codepen.io/alvarotrigo/pen/NxyPPp) for it if possible.
855862

856-
#Contributing to fullpage.js
863+
# Contributing to fullpage.js
857864
Please see [Contributing to fullpage.js](https://github.com/alvarotrigo/fullPage.js/wiki/Contributing-to-fullpage.js)
858865

859-
#Changelog
866+
# Changelog
860867
To see the list of recent changes, see [Releases section](https://github.com/alvarotrigo/fullPage.js/releases).
861868

862-
#Build tasks
869+
# Build tasks
863870
Want to build fullpage.js distribution files? Please see [Build Tasks](https://github.com/alvarotrigo/fullPage.js/wiki/Build-tasks)
864871

865-
#Resources
866-
- [Wordpress theme](http://alvarotrigo.com/fullPage/utils/wordpress.html)
872+
# Resources
873+
- [Wordpress theme 1](http://alvarotrigo.com/fullPage/utils/wordpress-y-theme.html)
874+
- [Wordpress theme 2](http://alvarotrigo.com/fullPage/utils/wordpress.html)
867875
- [CSS Easing Animation Tool - Matthew Lein](http://matthewlein.com/ceaser/) (useful to define the `easingcss3` value)
868876
- [fullPage.js jsDelivr CDN](http://www.jsdelivr.com/#!jquery.fullpage)
869877
- [fullPage.js plugin for October CMS](http://octobercms.com/plugin/freestream-parallax)

0 commit comments

Comments
 (0)