Skip to content

Commit 2165ae9

Browse files
committed
fix erroneous paths in ToCs
1 parent fbbddfb commit 2165ae9

2 files changed

Lines changed: 18 additions & 21 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Thank you for your interest in contributing to React Live Chat Loader! 🙌🏻
55
## 🖇️ Table of Contents
66

77
1. [Code of Conduct](CODE_OF_CONDUCT.md)
8-
2. [Reporting Bugs](#reporting-bugs)
9-
3. [Suggesting Features](#suggesting-features)
10-
4. [Creating Pull Requests](#creating-pull-requests)
11-
5. [Adding a Provider](#adding-a-provider)
8+
2. [Reporting Bugs](#-reporting-bugs)
9+
3. [Suggesting Features](#-suggesting-features)
10+
4. [Creating Pull Requests](#-creating-pull-requests)
11+
5. [Adding a Provider](#-adding-a-provider)
1212

1313
## 📣 Code of Conduct
1414
This project and everyone participating in it are governed by this [Code of Conduct](CODE_OF_CONDUCT.md). By participating, we expect you to act accordingly to this code. Please report unacceptable behaviour to [email protected].
@@ -166,7 +166,7 @@ Export the component from `src/index.js`
166166

167167
### 3. Update README
168168

169-
Add your new provider to this README under [Supported Providers](#supported-providers).
169+
Add your new provider to this README under [Supported Providers](README.md#-supported-providers).
170170

171171
### 4. Add an example page
172172

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ Made by the team at [♠ Calibre](https://calibreapp.com/), your performance com
1616

1717
## 🖇️ Table of Contents
1818

19-
1. [How it Works](#how-it-works)
20-
2. [Installation](#installation)
21-
3. [Usage](#usage)
22-
4. [Supported Providers](#supported-providers)
23-
5. [Adding a Provider](#adding-a-provider)
24-
6. [Contributing](#contributing)
25-
7. [Examples](#examples)
19+
1. [How it Works](#-how-it-works)
20+
2. [Installation](#-installation)
21+
3. [Usage](#-usage)
22+
4. [Supported Providers](#-supported-providers)
23+
5. [Adding a Provider](#-adding-a-provider)
24+
6. [Contributing](#-contributing)
25+
7. [Examples](#-examples)
2626

2727
## 💡 How it Works
2828

@@ -40,8 +40,7 @@ track how long the page has been idle for and checks if the person is on a slow
4040
connection (using `navigator.connection.effectiveType`) or has data-saver enabled
4141
(using `navigator.connection.saveData`) to prevent loading.
4242

43-
:warning: **Please note:** Some chat widget providers open automatically based on the people’s
44-
interaction from their last session.
43+
> ⚠️ **Please note**: Some chat widget providers open automatically based on the people’s interaction from their last session.
4544
4645
## 📥 Installation
4746

@@ -124,8 +123,8 @@ export const LoadChatButton = () => {
124123

125124
You can pass the following props to the `LiveChatLoaderProvider` provider:
126125

127-
- `provider`: Choose from `helpScout`, `intercom`, `drift` or `messenger` ([see below](#providers))
128-
- `providerKey`: Provider API Key ([see below](#providers))
126+
- `provider`: Choose from `helpScout`, `intercom`, `drift` or `messenger` ([see below](#-supported-providers))
127+
- `providerKey`: Provider API Key ([see below](#-supported-providers))
129128
- `idlePeriod`: How long to wait in ms before loading the provider. Default is
130129
`2000`. Set to `0` to never load. This value is used in a `setTimeout` in
131130
browsers that don't support `requestIdleCallback`.
@@ -195,7 +194,7 @@ export default class App extends React.Component {
195194
You can customise the color of the Intercom widget by passing a `color` prop to
196195
the `Intercom` component.
197196

198-
User or Company context data can be set using `window.intercomSettings`. See the [offical Intercom documentation](https://developers.intercom.com/installing-intercom/docs/javascript-api-attributes-objects#section-data-attributes) for more details.
197+
User or Company context data can be set using `window.intercomSettings`. See the [official Intercom documentation](https://developers.intercom.com/installing-intercom/docs/javascript-api-attributes-objects#section-data-attributes) for more details.
199198

200199
</details>
201200

@@ -244,9 +243,7 @@ You can customise the Messenger widget by passing the following props to the
244243

245244
For a list of options, refer to [Facebook Customer Chat Plugin documentation](https://developers.facebook.com/docs/messenger-platform/discovery/customer-chat-plugin#customization).
246245

247-
:warning: **Please note**: Facebook Messenger will not load on localhost and you will need
248-
to configure your domain through the setup wizard in Facebook for it to load
249-
correctly.
246+
> ⚠️ **Please note**: Facebook Messenger will not load on localhost and you will need to configure your domain through the setup wizard in Facebook for it to load correctly.
250247
251248
</details>
252249

@@ -343,7 +340,7 @@ You can customise the Chatwoot Widget by passing the following props to the
343340
</details>
344341

345342
## ➕ Adding a Provider
346-
To add a new live chat provider, follow the steps in [Contributing: Adding a Provider](CONTRIBUTING.md#adding-a-provider).
343+
To add a new live chat provider, follow the steps in [Contributing: Adding a Provider](CONTRIBUTING.md#-adding-a-provider).
347344

348345
## 🙌 Contributing
349346
Happy to hear you’re interested in contributing to React Live Chat Loader! Please find our contribution guidelines [here](CONTRIBUTING.md).

0 commit comments

Comments
 (0)