auto fix & formating
This commit is contained in:
Sylvain Pace
parent
b72c140247
commit
641238cc3e
9 changed files with 50 additions and 50 deletions
|
|
@ -10,7 +10,7 @@ module.exports = {
|
|||
exclude: [
|
||||
'relative to', // We need to talk about links "relative to the root",
|
||||
'pick out', // Needed word, not to clumsy
|
||||
'encounter' // Needed word, not to clumsy
|
||||
'encounter', // Needed word, not to clumsy
|
||||
],
|
||||
},
|
||||
terminology: {
|
||||
|
|
@ -22,4 +22,4 @@ module.exports = {
|
|||
severity: 'warning',
|
||||
},
|
||||
},
|
||||
};
|
||||
};
|
||||
|
|
|
|||
|
|
@ -199,8 +199,8 @@ Here, all documentation pages will use the selectors defined in
|
|||
## `selectors`
|
||||
|
||||
This object contains all the CSS selectors that will be used to create the
|
||||
record hierarchy. It can contain up to 6 levels (`lvl0`, `lvl1`, `lvl2`,
|
||||
`lvl3`, `lvl4`, `lvl5`) and `text`.
|
||||
record hierarchy. It can contain up to 6 levels (`lvl0`, `lvl1`, `lvl2`, `lvl3`,
|
||||
`lvl4`, `lvl5`) and `text`.
|
||||
|
||||
A default config would be to target the page `title` or `h1` as `lvl0`, the `h2`
|
||||
as `lvl1`, `h3` as `lvl2`, and `p` as `text`, but this is highly dependent on
|
||||
|
|
@ -420,10 +420,10 @@ other selectors easier to write.
|
|||
|
||||
### `stop_urls` _Optional_
|
||||
|
||||
This is an array of strings or regular expressions. Whenever the crawler is about
|
||||
to visit a link, it will first check if the link matches something in the array.
|
||||
If it does, it will not follow the link. This should be used to restrict pages
|
||||
the crawler should visit.
|
||||
This is an array of strings or regular expressions. Whenever the crawler is
|
||||
about to visit a link, it will first check if the link matches something in the
|
||||
array. If it does, it will not follow the link. This should be used to restrict
|
||||
pages the crawler should visit.
|
||||
|
||||
Note that this is often used to avoid duplicate content, by adding
|
||||
`http://www.example.com/docs/index.html` if you already have
|
||||
|
|
@ -480,9 +480,10 @@ crawled.
|
|||
|
||||
## JavaScript rendering
|
||||
|
||||
By default DocSearch expects websites to have server-side rendering, meaning that
|
||||
HTML source is returned directly by the server. If your content is generated by
|
||||
the front-end, you have to tell DocSearch to emulate a browser through Selenium.
|
||||
By default DocSearch expects websites to have server-side rendering, meaning
|
||||
that HTML source is returned directly by the server. If your content is
|
||||
generated by the front-end, you have to tell DocSearch to emulate a browser
|
||||
through Selenium.
|
||||
|
||||
_As client-side crawling is way slower than server-side crawling, we highly
|
||||
encourage you to update your website to enable server-side rendering._
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ layout: two-columns
|
|||
title: Dropdown
|
||||
---
|
||||
|
||||
Once your Algolia DocSearch index is ready, correctly set up, and filled with the
|
||||
right data, you will need to integrate our dedicated Search-UI. To add the
|
||||
Once your Algolia DocSearch index is ready, correctly set up, and filled with
|
||||
the right data, you will need to integrate our dedicated Search-UI. To add the
|
||||
dropdown of results below your search input, you'll have to include our
|
||||
DocSearch 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
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ layout: two-columns
|
|||
title: FAQ
|
||||
---
|
||||
|
||||
If you're not finding the answer to your question on this website, this page will
|
||||
help you. If you're still unsure, don't hesitate to send [your question to
|
||||
If you're not finding the answer to your question on this website, this page
|
||||
will help you. If you're still unsure, don't hesitate to send [your question to
|
||||
us][1] directly.
|
||||
|
||||
### How often will you crawl my website?
|
||||
|
|
@ -40,10 +40,10 @@ account ([free accounts][4] can hold as much as 10k records).
|
|||
|
||||
### What data are you collecting?
|
||||
|
||||
We only save the data we extract from your website markup,
|
||||
which we put in a custom JSON format instead of HTML.
|
||||
This is the only data we put in the Algolia DocSearch index.
|
||||
This data is based on the selectors defined in your config file,
|
||||
We only save the data we extract from your website markup, which we put in a
|
||||
custom JSON format instead of HTML. This is the only data we put in the Algolia
|
||||
DocSearch index. This data is based on the selectors defined in your config
|
||||
file,
|
||||
|
||||
As the website owner, we also give you access to the Algolia Analytics
|
||||
dashboard. This will let you have more data about the anonymized searches that
|
||||
|
|
@ -101,10 +101,10 @@ as those starting with `http://`.
|
|||
|
||||
We'd love to help!
|
||||
|
||||
If one of your favorite tool documentation websites is missing DocSearch, we encourage
|
||||
you to file an issue in their repository explaining how DocSearch could help.
|
||||
Feel free to ping `@docsearch` on GitHub in the issue as well, and we'll provide
|
||||
all the help we can.
|
||||
If one of your favorite tool documentation websites is missing DocSearch, we
|
||||
encourage you to file an issue in their repository explaining how DocSearch
|
||||
could help. Feel free to ping `@docsearch` on GitHub in the issue as well, and
|
||||
we'll provide all the help we can.
|
||||
|
||||
[1]: mailto:docsearch@algolia.com
|
||||
[2]: https://www.algolia.com/
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ layout: two-columns
|
|||
title: Inside the engine
|
||||
---
|
||||
|
||||
This page will explain in more detail how the crawler extracts content from
|
||||
your page every 24h, and how it ranks the results.
|
||||
This page will explain in more detail how the crawler extracts content from your
|
||||
page every 24h, and how it ranks the results.
|
||||
|
||||
## Crawling
|
||||
|
||||
|
|
@ -24,8 +24,8 @@ settings, we extract the payload of your web page and index it, preserving your
|
|||
data's structure. This is achieved in a simple way:
|
||||
|
||||
- We **read top down** your web page following your HTML flow and pick out your
|
||||
matching elements according to their **levels** based on the
|
||||
`selectors_level` defined.
|
||||
matching elements according to their **levels** based on the `selectors_level`
|
||||
defined.
|
||||
- We create a record for each paragraph along with its hierarchical path. This
|
||||
construction is based on their **time of appearance** along the flow.
|
||||
- We **index** these records with the appropriate global settings (e.g.
|
||||
|
|
@ -65,5 +65,4 @@ your config.
|
|||
[1]: https://www.sitemaps.org/
|
||||
[2]:
|
||||
https://www.algolia.com/doc/guides/ranking/ranking-formula/#tie-breaking-approach
|
||||
|
||||
[3]:[https://www.algolia.com/doc/guides/ranking/custom-ranking/]
|
||||
[3]: https://www.algolia.com/doc/guides/ranking/custom-ranking/
|
||||
|
|
|
|||
|
|
@ -4,18 +4,18 @@ title: Supported Integrations
|
|||
---
|
||||
|
||||
We worked with **documentation website generators** to have DocSearch directly
|
||||
embedded as a first class citizen in the websites they produce.
|
||||
embedded as a first class citizen in the websites they produce.
|
||||
|
||||
So, if you're using one of the following tools,
|
||||
checkout their documentation to see how to enable DocSearch on your website:
|
||||
So, if you're using one of the following tools, checkout their documentation to
|
||||
see how to enable DocSearch on your website:
|
||||
|
||||
- [Docusaurus][1] - [How to enable search][2]
|
||||
- [VuePress][3] - [Algolia Search][4]
|
||||
- [GitBook][5]
|
||||
- [pkgdown][6] - [DocSearch indexing][7]
|
||||
|
||||
Additionally, if you're a maintaining a similar tool and would like to be added to the list,
|
||||
get [in touch with us][8]. We'd be happy to help.
|
||||
Additionally, if you're a maintaining a similar tool and would like to be added
|
||||
to the list, get [in touch with us][8]. We'd be happy to help.
|
||||
|
||||
[1]: https://docusaurus.io/
|
||||
[2]: https://docusaurus.io/docs/en/search#docsNav
|
||||
|
|
|
|||
|
|
@ -77,13 +77,13 @@ docsearch({
|
|||
|
||||
## Other considerations
|
||||
|
||||
Selected suggestions are wrapped in a `.ds-cursor` class. This means that you can
|
||||
use `.ds-cursor .algolia-docsearch-suggestion--content` to style the selected
|
||||
suggestion for example.
|
||||
Selected suggestions are wrapped in a `.ds-cursor` class. This means that you
|
||||
can use `.ds-cursor .algolia-docsearch-suggestion--content` to style the
|
||||
selected suggestion for example.
|
||||
|
||||
On small screens, DocSearch reverts to a single column layout, while the
|
||||
two-column layout shown in the screenshot is used on larger screens. You can
|
||||
add media queries (for example `@media (min-width: 768px) {}`) to target different
|
||||
two-column layout shown in the screenshot is used on larger screens. You can add
|
||||
media queries (for example `@media (min-width: 768px) {}`) to target different
|
||||
displays.
|
||||
|
||||
## Advanced styling
|
||||
|
|
|
|||
|
|
@ -4,14 +4,14 @@ title: Tips for a good search
|
|||
---
|
||||
|
||||
DocSearch can work with almost any website, but we found that some site
|
||||
structures yield more relevant result or faster indexing time. In this page we'll
|
||||
share some tips on how you can make the most out of DocSearch.
|
||||
structures yield more relevant result or faster indexing time. In this page
|
||||
we'll share some tips on how you can make the most out of DocSearch.
|
||||
|
||||
### Use a `sitemap.xml`
|
||||
|
||||
If you provide a sitemap in your configuration, DocSearch will use it to
|
||||
diretly browse the pages to index. Pages are still crawled which means we
|
||||
extract every compliant link.
|
||||
If you provide a sitemap in your configuration, DocSearch will use it to diretly
|
||||
browse the pages to index. Pages are still crawled which means we extract every
|
||||
compliant link.
|
||||
|
||||
We highly recommend you add a `sitemap.xml` to your website if you don't have
|
||||
one already. This will make the indexing faster, but will also give you more
|
||||
|
|
@ -54,8 +54,8 @@ This will help narrow selectors to the relevant content.
|
|||
|
||||
Having such a unique identifier will make your configuration more robust as it
|
||||
will make sure all indexed content is relevant content. We found that this is
|
||||
the most reliable way to exclude content in headers, sidebars, and footers that are
|
||||
not relevant to the search.
|
||||
the most reliable way to exclude content in headers, sidebars, and footers that
|
||||
are not relevant to the search.
|
||||
|
||||
### Add anchors to headings
|
||||
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ large technical documentation. For that reason, we are offering a free hosting
|
|||
version to all online technical documentation.
|
||||
|
||||
We're always sad to have to turn down applications, but with the number of
|
||||
requests we receive everyday, we've had to focus on several criteria. We hope you
|
||||
understand.
|
||||
requests we receive everyday, we've had to focus on several criteria. We hope
|
||||
you understand.
|
||||
|
||||
### The checklist
|
||||
|
||||
|
|
@ -40,8 +40,8 @@ Algolia's features.
|
|||
### Priority
|
||||
|
||||
We're receiving dozens of requests every day, and while we strive to answer them
|
||||
all as fast as we can, we sometimes give priority to some based on the
|
||||
following criteria:
|
||||
all as fast as we can, we sometimes give priority to some based on the following
|
||||
criteria:
|
||||
|
||||
- 🙂 If your project is open source, we'll handle it before any other
|
||||
closed-source product. We love open source and want to help as much as we can.
|
||||
|
|
|
|||
Loading…
Reference in a new issue