diff options
| author | Sarah German <sgerman@gitlab.com> | 2022-04-20 00:40:12 +0300 |
|---|---|---|
| committer | David O'Regan <doregan@gitlab.com> | 2022-04-20 00:40:12 +0300 |
| commit | 6087ee1711e6ea9ae4904503d1d9d0dc88b9a384 (patch) | |
| tree | 28781d7df57f1b6fe8ec5aba7a965374d6a1c102 /doc | |
| parent | 5baa0e2661fefb66fc7f4275a174109e8782c58e (diff) | |
Remove duplicate Docsearch configuration object
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/docsearch.md | 23 |
1 files changed, 7 insertions, 16 deletions
diff --git a/doc/docsearch.md b/doc/docsearch.md index 0188d352..b0cd1244 100644 --- a/doc/docsearch.md +++ b/doc/docsearch.md @@ -10,26 +10,17 @@ and DocSearch provides a dropdown search experience on our website. ## DocSearch implementation details -DocSearch is defined in various places: - -- Home page: - - Javascript: [`content/frontend/home/index.js`](../content/frontend/home/index.js) - - Layout: [`content/index.erb`](../content/index.erb) -- Dedicated search page under `/search`: - - Javascript: [`content/frontend/search/index.js`](../content/frontend/search/index.js) - - Layout: [`layouts/instantsearch.html`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/layouts/instantsearch.html) -- Every other page: - - Javascript: [`content/assets/javascripts/docsearch.js`](../content/assets/javascripts/docsearch.js) - - Layout: [`layouts/docsearch.html`](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/layouts/docsearch.html) +DocSearch layouts are defined in various places: + +- Home page: [`content/index.erb`](../content/index.erb) +- Dedicated search page under `/search`: [`layouts/instantsearch.html`](../layouts/instantsearch.html) +- Every other page: [`layouts/docsearch.html`](../layouts/docsearch.html) A Javascript snippet initiates docsearch by using an API key, app ID, and an index name that are needed for Algolia to show the results: -```js -apiKey: '89b85ffae982a7f1adeeed4a90bb0ab1', -indexName: 'gitlab', -appId: '3PNCFOU757' -``` +- Dedicated search page under `/search`: [`content/frontend/search/index.js`](../content/frontend/search/index.js) +- Every other page: [`content/assets/javascripts/docsearch.js`](../content/assets/javascripts/docsearch.js) ## Override DocSearch CSS |