Skip to content

Commit 5cdeaca

Browse files
committed
- Aesthetics changes
1 parent 5a632e3 commit 5cdeaca

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ bower install fullpage.js
8484
npm install fullpage.js
8585
```
8686

87-
###Including files:
87+
### Including files:
8888
```html
8989
<link rel="stylesheet" type="text/css" href="jquery.fullPage.css" />
9090

@@ -100,11 +100,11 @@ npm install fullpage.js
100100
<script type="text/javascript" src="jquery.fullPage.js"></script>
101101
```
102102

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

107-
###Required HTML structure
107+
### Required HTML structure
108108
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>`.
109109

110110
Each section will be defined with an element containing the `section` class.
@@ -135,7 +135,7 @@ In order to create a landscape slider within a section, each slide will be defin
135135
````
136136
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).
137137

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

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

285-
###Lazy Loading
285+
### Lazy Loading
286286
[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.
287287
When using lazy loading, all these elements will only get loaded when entering in the viewport.
288288
To enable lazy loading all you need to do is change your `src` attribute to `data-src` as shown below:
@@ -297,7 +297,7 @@ To enable lazy loading all you need to do is change your `src` attribute to `dat
297297

298298
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`.
299299

300-
###Auto play/pause embedded media
300+
### Auto play/pause embedded media
301301

302302
**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).
303303

@@ -319,7 +319,7 @@ Embedded HTML5 `<video>` / `<audio>` and Youtube iframes are automatically paus
319319
</audio>
320320
```
321321

322-
###Use extensions
322+
### Use extensions
323323
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).
324324

325325
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`).
@@ -663,7 +663,7 @@ $.fn.fullpage.responsiveSlides.toSlides();
663663
## Callbacks
664664
[Demo](http://codepen.io/alvarotrigo/pen/XbPNQv) You can see them in action [here](http://alvarotrigo.com/fullPage/examples/callbacks.html).
665665

666-
###afterLoad (`anchorLink`, `index`)
666+
### afterLoad (`anchorLink`, `index`)
667667
Callback fired once the sections have been loaded, after the scrolling has ended.
668668
Parameters:
669669

@@ -694,7 +694,7 @@ Example:
694694
});
695695
```
696696
---
697-
###onLeave (`index`, `nextIndex`, `direction`)
697+
### onLeave (`index`, `nextIndex`, `direction`)
698698
This callback is fired once the user leaves a section, in the transition to the new section.
699699
Returning `false` will cancel the move before it takes place.
700700

@@ -723,7 +723,7 @@ Example:
723723
});
724724
```
725725

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

729729
```javascript
@@ -738,7 +738,7 @@ You can cancel the scroll by returning `false` on the `onLeave` callback:
738738
```
739739

740740
---
741-
###afterRender()
741+
### afterRender()
742742
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.
743743

744744
Example:
@@ -752,7 +752,7 @@ Example:
752752
});
753753
```
754754
---
755-
###afterResize()
755+
### afterResize()
756756
This callback is fired after resizing the browser's window. Just after the sections are resized.
757757

758758
Example:
@@ -766,7 +766,7 @@ Example:
766766
});
767767
```
768768
---
769-
###afterResponsive(`isResponsive`)
769+
### afterResponsive(`isResponsive`)
770770
This callback is fired after fullpage.js changes from normal to responsive mode or from responsive mode to normal mode.
771771

772772
Parameters:
@@ -783,7 +783,7 @@ Example:
783783
});
784784
```
785785
---
786-
###afterSlideLoad (`anchorLink`, `index`, `slideAnchor`, `slideIndex`)
786+
### afterSlideLoad (`anchorLink`, `index`, `slideAnchor`, `slideIndex`)
787787
Callback fired once the slide of a section have been loaded, after the scrolling has ended.
788788
Parameters:
789789

@@ -818,7 +818,7 @@ Example:
818818

819819

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

@@ -851,7 +851,7 @@ Example:
851851
});
852852
```
853853

854-
####Cancelling a move before it takes place
854+
#### Cancelling a move before it takes place
855855
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).
856856

857857
#Reporting issues

0 commit comments

Comments
 (0)