Skip to content

Commit 766d7ba

Browse files
committed
fix doc links
1 parent 58e50cb commit 766d7ba

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,16 @@ yarn add react-scroll-parallax
2929
## Overview
3030

3131
- [Usage](#usage)
32-
- [`<Parallax>`](/parallax-component.md)
33-
- [Parallax Props](/parallax-component.md#parallax-props)
34-
- [`<ParallaxBanner>`](/parallax-banner-component.md)
35-
- [Banner Usage](/parallax-banner-component.md#banner-usage)
36-
- [Banner Props](/parallax-banner-component.md#banner-props)
37-
- [Banner Layers Prop](/parallax-banner-component.md#banner-layers-prop)
38-
- [`<ParallaxProvider>`](/parallax-provider-component.md)
39-
- [ParallaxProvider Props](/parallax-provider-component.md#parallaxprovider-props)
40-
- [Parallax Controller Context](/parallax-controller-context.md)
41-
- [Available Methods](/parallax-controller-context.md#available-methods)
32+
- [`<Parallax>`](/docs/parallax-component.md)
33+
- [Parallax Props](/docs/parallax-component.md#parallax-props)
34+
- [`<ParallaxBanner>`](/docs/parallax-banner-component.md)
35+
- [Banner Usage](/docs/parallax-banner-component.md#banner-usage)
36+
- [Banner Props](/docs/parallax-banner-component.md#banner-props)
37+
- [Banner Layers Prop](/docs/parallax-banner-component.md#banner-layers-prop)
38+
- [`<ParallaxProvider>`](/docs/parallax-provider-component.md)
39+
- [ParallaxProvider Props](/docs/parallax-provider-component.md#parallaxprovider-props)
40+
- [Parallax Controller Context](/docs/parallax-controller-context.md)
41+
- [Available Methods](/docs/parallax-controller-context.md#available-methods)
4242
- [Browser Support](#browser-support)
4343
- [Optimizations to Reduce Jank](#optimizations-to-reduce-jank)
4444
- [PSA](#psa)

docs/parallax-banner-component.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## \<ParallaxBanner>
1+
# \<ParallaxBanner>
22

33
Component that utilizes `<Parallax>` components to achieve a parallaxing banner effect. Allows a single or multiple images to be parallaxed at different rates within the banner area.
44

5-
### Banner Usage
5+
## Banner Usage
66

77
Use the `layers` prop to indicate all images, offset amounts, and scroll rates. Optionally pass additional children to be rendered. Styles of the outermost banner element can also be changed. Here's an example:
88

@@ -27,7 +27,7 @@ Use the `layers` prop to indicate all images, offset amounts, and scroll rates.
2727
</ParallaxBanner>
2828
```
2929

30-
### Banner Props
30+
## Banner Props
3131

3232
The following are all props that can be passed to the `<ParallaxBanner>` component:
3333

@@ -38,7 +38,7 @@ The following are all props that can be passed to the `<ParallaxBanner>` compone
3838
| **layers** | `array` | | A required `array` of `objects` with layer properties: `[{ amount: 0.1, image: 'foo.jpg' }]`. [See layers prop below](#banner-layers-prop) |
3939
| **style** | `object` | | Optionally pass a style object to be added to the outermost parallax banner element. |
4040

41-
### Banner Layers Prop
41+
## Banner Layers Prop
4242

4343
The `layers` prop takes an array of objects that will represent each image (or custom children) of the parallax banner. The following properties describe a layer object:
4444

docs/parallax-component.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## \<Parallax>
1+
# \<Parallax>
22

33
The main component for manipulating a DOM element's position based on it's position within the viewport.
44

5-
### Parallax Props
5+
## Parallax Props
66

77
The following are all props that can be passed to the `<Parallax>` component:
88

docs/parallax-controller-context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const MyComponent = () => {
1515
};
1616
```
1717

18-
### Available Methods
18+
## Available Methods
1919

2020
Access the following methods on `parallaxController` via context:
2121

@@ -27,7 +27,7 @@ Updates all cached attributes for parallax elements then updates their positions
2727

2828
Removes window scroll and resize listeners then resets all styles applied to parallax elements.
2929

30-
### Example usage of context
30+
## Example usage of context
3131

3232
The most common use case that would require access to the controller is dealing with images. Since the controller caches attributes for performance they will need to be updated with the correct values once the image loads. Here's an example of how you could do that with an `<Image />` component:
3333

docs/parallax-provider-component.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## \<ParallaxProvider>
1+
# \<ParallaxProvider>
22

33
The `<ParallaxProvider />` component is meant to wrap a top level component in your application and is necessary to provide access though React context API to the parallax controller. This component should only be used once in you app, for instance in an `<AppContainer />` component that won't be mounted/unmounted during route changes. Like so:
44

@@ -12,7 +12,7 @@ const AppContainer = () => (
1212
);
1313
```
1414

15-
### ParallaxProvider Props
15+
## ParallaxProvider Props
1616

1717
The following props configure the `<ParallaxProvider>` component:
1818

0 commit comments

Comments
 (0)