diff --git a/docs/.remarkrc.js b/docs/.remarkrc.js
index 6ec248af..ec3b4a37 100644
--- a/docs/.remarkrc.js
+++ b/docs/.remarkrc.js
@@ -17,6 +17,8 @@ const lintConfig = {
'lint-no-trailing-spaces', // No trailing spaces
['lint-emphasis-marker', '_'], // Italic with _, bold with **
['lint-list-item-indent', 'space'], // Indent list items with one space
+ ['lint-maximum-heading-length', 80], // Warn on heading that can be too long
+ ['lint-maximum-line-length', 120], // Warn on lines that are too long
],
};
const fixConfig = {
@@ -28,7 +30,6 @@ const fixConfig = {
plugins: {
frontmatter: true,
'reference-links': true,
- 'word-wrap': true,
},
};
diff --git a/docs/package.json b/docs/package.json
index cae4dfc4..b2204bc6 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -61,7 +61,6 @@
"remark-preset-lint-markdown-style-guide": "^2.1.2",
"remark-preset-lint-recommended": "^3.0.2",
"remark-reference-links": "^4.0.2",
- "remark-word-wrap": "^2.0.2",
"stylelint": "^9.3.0",
"stylelint-csstree-validator": "^1.3.0",
"tailwindcss": "^0.6.4"
diff --git a/docs/scripts/lint-md-fix b/docs/scripts/lint-md-fix
index 2d9cee1b..ae825426 100755
--- a/docs/scripts/lint-md-fix
+++ b/docs/scripts/lint-md-fix
@@ -3,5 +3,5 @@
REMARK_MODE=fix \
remark \
--quiet \
- --output ./src/updated.md \
- ./src/test.md
+ ./src/*.md \
+ --output
diff --git a/docs/src/behavior.md b/docs/src/behavior.md
index 00e1b57c..f33537a8 100644
--- a/docs/src/behavior.md
+++ b/docs/src/behavior.md
@@ -32,8 +32,10 @@ The method is called with three arguments:
- `input`, a reference to the search `input` element. It comes with the `.open()`,
`.close()`, `.getVal()` and `.setVal()` methods.
+
- `event`, the actual event triggering the selection. This can come from a click
or a keyboard navigation.
+
- `suggestion`, the object representing the current selection.
```javascript
diff --git a/docs/src/config-file.md b/docs/src/config-file.md
index 38c6b43a..5d8eee96 100644
--- a/docs/src/config-file.md
+++ b/docs/src/config-file.md
@@ -27,7 +27,7 @@ A DocSearch looks like this:
}
```
-## ``index_name``
+## `index_name`
This is the name of the Algolia index where your records will be pushed. The
`apiKey` we will share with you will be restricted to work on this index.
@@ -80,9 +80,9 @@ The following example will make it clearer:
```
The beneficial side effect of using this syntax is that all records that will
-then be extracted from crawling `http://www.example.com/docs/en/latest` will have
-`lang: en` and `version: latest` added to it, allowing you to then filter based on
-those values.
+then be extracted from crawling `http://www.example.com/docs/en/latest` will
+have `lang: en` and `version: latest` added to it, allowing you to then filter
+based on those values.
The following example shows how you can filter results matching specifics
language and version from the front-end
@@ -342,7 +342,9 @@ recommend changing it as the default settings are meant to work for all
websites.
One use case would be to configure the `separatorsToIndex` setting. By default
-Algolia will consider all special character as a word separator. In some contexts, like for method names, you might want `_`, `/` or `#` to keep their meaning.
+Algolia will consider all special character as a word separator. In some
+contexts, like for method names, you might want `_`, `/` or `#` to keep their
+meaning.
```json
{
@@ -354,7 +356,6 @@ Algolia will consider all special character as a word separator. In some context
Check the [Algolia documentation][2] for more information on the settings.
-
### `min_indexed_level` _Optional_
The default value is `0`. By increasing it, you can chose to not index some
@@ -485,11 +486,11 @@ With the above config and the `sitemap.xml` below, both
`http://www.example.com/docs/` and `http://www.example.com/docs/de/` will be
crawled.
-```
-
- http://www.example.com/docs/
-
-
+```html
+
+ http://www.example.com/docs/
+
+
```
## JavaScript rendering
@@ -547,4 +548,5 @@ DocSearch to index all your content.
```
[1]: https://github.com/algolia/docsearch-configs/tree/master/configs
+
[2]: https://www.algolia.com/doc/api-reference/settings-api-parameters/
diff --git a/docs/src/crawler-overview.md b/docs/src/crawler-overview.md
index c73c41ee..f5a79710 100644
--- a/docs/src/crawler-overview.md
+++ b/docs/src/crawler-overview.md
@@ -27,5 +27,7 @@ open-source][3] and even packaged as a Docker image. Just grab it, and run it
with your own credentials.
[1]: https://scrapy.org/
+
[2]: ./crawler-config.html
+
[3]: https://github.com/algolia/docsearch-scraper
diff --git a/docs/src/dropdown.md b/docs/src/dropdown.md
index cb58093d..c881c4f6 100644
--- a/docs/src/dropdown.md
+++ b/docs/src/dropdown.md
@@ -8,23 +8,22 @@ the `docsearch.js` library into your website as per the following example. Your
`apiKey` and `indexName` credentials will be given to you as soon as we've
created your config.
-
```html
-
+
-
-
+