Skip to content

Commit d3f0aac

Browse files
pborreliSylvain Pace
authored and
Sylvain Pace
committed
doc(site): Fixed typos (#277)
1 parent bd7c7a2 commit d3f0aac

File tree

11 files changed

+16
-16
lines changed

11 files changed

+16
-16
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ set white and purple colors.
120120
.algolia-docsearch-suggestion--highlight {
121121
color: #3A33D1;
122122
}
123-
/* Highligted search terms in the main category headers */
123+
/* Highlighted search terms in the main category headers */
124124
.algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight {
125125
background-color: #4D47D5;
126126
}

docs/source/assets/stylesheets/_searchbar.scss

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ $custom:(
115115
text-align: center;
116116
user-select: none;
117117

118-
// Helper for vertical alignement of the icon
118+
// Helper for vertical alignment of the icon
119119
&::before {
120120
display: inline-block;
121121
margin-right: -4px;

docs/source/documentation/2-docsearch-scraper/2-config-options.html.md.erb

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Name of the Algolia index where all the data will be pushed.
6363

6464
**On our own infrastructure, this name must be equal to the configuration file name**
6565

66-
We mostly attribute it on our own regarding plenty of underlying factors. The `apiKey` that we provide is generated with a restriction on the `index_name`. Changing the `index_name` would require to ask for a new key. Thus if you want to **change the name**, please **submit a new configration**, we will generate a new key accordingly.
66+
We mostly attribute it on our own regarding plenty of underlying factors. The `apiKey` that we provide is generated with a restriction on the `index_name`. Changing the `index_name` would require to ask for a new key. Thus if you want to **change the name**, please **submit a new configuration**, we will generate a new key accordingly.
6767

6868
### `start_urls` _Mandatory_
6969
You can pass either a string or an array of urls. The crawler will go to each
@@ -115,7 +115,7 @@ You can also define some `tags` that will also behave as [`attributesForFaceting
115115

116116
In order to promote some pages, you can set the `page_rank` attribute (default: `0`, can be a positive or negative integer).
117117

118-
Finally, If your website contains differents parts and layouts, you can define specific `selectors` for each part and apply them using `selectors_key`:
118+
Finally, If your website contains different parts and layouts, you can define specific `selectors` for each part and apply them using `selectors_key`:
119119

120120
Example:
121121
```json
@@ -343,7 +343,7 @@ settings. You will [look under the hood of algolia](https://www.algolia.com/doc/
343343

344344
The number of maximum records allowed for the whole indexing. If the scrapping is bigger, it will fail.
345345

346-
This value is not meant to be set from anyone except DocSearch maintaner.
346+
This value is not meant to be set from anyone except DocSearch maintainer.
347347

348348
Default is `600 000` (arbitrary, might change)
349349

docs/source/documentation/3-docsearch-autocomplete/1-customize-autocomplete-styles.html.md.erb

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ set white and purple colors.
3434
.algolia-docsearch-suggestion--highlight {
3535
color: #3A33D1;
3636
}
37-
/* Highligted search terms in the main category headers */
37+
/* Highlighted search terms in the main category headers */
3838
.algolia-docsearch-suggestion--category-header .algolia-docsearch-suggestion--highlight {
3939
background-color: #4D47D5;
4040
}

scripts/test-coverage

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# This file will then be read by Travis to push it to Coveralls
44
#
55
# The command is long and was quite hard to write correctly.
6-
# We need babel-istanbul and not instanbul
6+
# We need babel-istanbul and not istanbul
77
# We need the _mocha and not mocha
88
# We need to use full path for each binaries
99
# We need to run everything through babel-node

src/lib/DocSearch.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ class DocSearch {
249249
'<span class="aa-suggestion-title-separator" aria-hidden="true"> › </span>'
250250
);
251251
const text = utils.getSnippetedValue(hit, 'content');
252-
const isTextOrSubcatoryNonEmpty =
252+
const isTextOrSubcategoryNonEmpty =
253253
(subcategory && subcategory !== '') ||
254254
(displayTitle && displayTitle !== '');
255255
const isLvl1EmptyOrDuplicate =
@@ -268,7 +268,7 @@ class DocSearch {
268268
isLvl1EmptyOrDuplicate,
269269
isCategoryHeader: hit.isCategoryHeader,
270270
isSubCategoryHeader: hit.isSubCategoryHeader,
271-
isTextOrSubcatoryNonEmpty,
271+
isTextOrSubcategoryNonEmpty,
272272
category,
273273
subcategory,
274274
title: displayTitle,

src/lib/__tests__/DocSearch-test.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,7 @@ describe('DocSearch', () => {
349349
});
350350

351351
describe('the returned function', () => {
352-
it('calls the Agolia client with the correct parameters', () => {
352+
it('calls the Algolia client with the correct parameters', () => {
353353
// Given
354354
const actual = docsearch.getAutocompleteSource();
355355

@@ -369,7 +369,7 @@ describe('DocSearch', () => {
369369
});
370370

371371
describe('when queryHook is used', () => {
372-
it('calls the Agolia client with the correct parameters', () => {
372+
it('calls the Algolia client with the correct parameters', () => {
373373
// Given
374374
const actual = docsearch.getAutocompleteSource(
375375
false,

src/lib/templates.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ const templates = {
1717
<div class="${suggestionPrefix}--subcategory-column">
1818
<span class="${suggestionPrefix}--subcategory-column-text">{{{subcategory}}}</span>
1919
</div>
20-
{{#isTextOrSubcatoryNonEmpty}}
20+
{{#isTextOrSubcategoryNonEmpty}}
2121
<div class="${suggestionPrefix}--content">
2222
<div class="${suggestionPrefix}--subcategory-inline">{{{subcategory}}}</div>
2323
<div class="${suggestionPrefix}--title">{{{title}}}</div>
2424
{{#text}}<div class="${suggestionPrefix}--text">{{{text}}}</div>{{/text}}
2525
</div>
26-
{{/isTextOrSubcatoryNonEmpty}}
26+
{{/isTextOrSubcategoryNonEmpty}}
2727
</div>
2828
</div>
2929
`,

src/lib/utils.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ const utils = {
233233
* text: 'This is an unfinished sentence'
234234
* }, 'text');
235235
* =>
236-
* '<mark>This is an unefinished sentenced</mark>…'
236+
* '<mark>This is an unfinished sentence</mark>…'
237237
* @param {object} object Hit object returned by the Algolia API
238238
* @param {string} property Object key to look for
239239
* @return {string}

src/styles/_dropdown.scss

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
}
5151
}
5252

53-
// Alignement type
53+
// Alignment type
5454
@mixin alignment-type($type) {
5555
@if $type == 'left' {
5656
left: 0 !important;

src/styles/_searchbox.scss

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@
127127
left: 0;
128128
}
129129

130-
// Helper for vertical alignement of the icon
130+
// Helper for vertical alignment of the icon
131131
&::before {
132132
display: inline-block;
133133
margin-right: -4px;

0 commit comments

Comments
 (0)