Fix HTML element syntax in docs (#886)
Best practice is to portray HTML tags without a forward slash `/`, especially when the tags aren't self-closing.¹ 1. https://developer.mozilla.org/en-US/docs/Web/HTML/Element
This commit is contained in:
parent
7a6f0a1727
commit
2288312534
3 changed files with 5 additions and 5 deletions
|
|
@ -54,7 +54,7 @@ different value. This variable can be set in the .env file alongside
|
|||
## `start_urls`
|
||||
|
||||
This array contains the list of URLs that will be used to start crawling your
|
||||
website. The crawler will recursively follow any links (`<a/>` tags) from those
|
||||
website. The crawler will recursively follow any links (`<a>` tags) from those
|
||||
pages. It will not follow links that are on another domain and never follow
|
||||
links matching `stop_urls`.
|
||||
|
||||
|
|
|
|||
|
|
@ -131,7 +131,7 @@ that some pages are missing from the search. The possible reasons for that are:
|
|||
- Makes sure you are not filtering on the search by wrongly using
|
||||
`facetFilters`. [See here for more details][11].
|
||||
- Make sure that an other indexed page references the page missing thanks to a
|
||||
hyperlink tag `<a/>`.
|
||||
hyperlink tag `<a>`.
|
||||
- Make sure you are [providing a compliant sitemap from the configuration][12]
|
||||
and that it references the page.
|
||||
|
||||
|
|
|
|||
|
|
@ -63,7 +63,7 @@ These classes can not involve any style changes. These dedicated classes will
|
|||
help us to create a great learn as you type experience from your documentation.
|
||||
|
||||
- Add a static class `DocSearch-content` to the main container of your textual
|
||||
content. Most of the time, this tag `<main/>` or an `<article/>` HTML element.
|
||||
content. Most of the time, this tag `<main>` or an `<article>` HTML element.
|
||||
|
||||
- Every searchable `lvl` elements outside this main documentation container (for
|
||||
instance in a sidebar) must be `global` selectors. They will be globally
|
||||
|
|
@ -81,8 +81,8 @@ help us to create a great learn as you type experience from your documentation.
|
|||
the exact place of the matching elements. These attributes defined the right
|
||||
anchor to use.
|
||||
|
||||
- Every textual element (selector `text`) must be wrapped in a tag `<p/>` or
|
||||
`<li/>`. This content must be atomic and split into small entities. Be careful
|
||||
- Every textual element (selector `text`) must be wrapped in a tag `<p>` or
|
||||
`<li>`. This content must be atomic and split into small entities. Be careful
|
||||
to never nest one matching elements into another one, it will create
|
||||
duplicates.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue