Skip to content

Commit

Permalink
Merge branch 'main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
randombeeper authored Jun 6, 2024
2 parents 5dc1c65 + 53fcbe0 commit a3eefa7
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 13 deletions.
8 changes: 8 additions & 0 deletions packages/website/docs/crawler.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,14 @@ We provide [config templates](/docs/templates) for many website generators, but

The Crawler only applies `index settings` at index creation index, to keep the Algolia dashboard as the source of truth. If you have drastically changed your config, or moved to a website generator, we recommend you to delete your index from the Algolia dashboard before starting a new crawl.

## Can I delete my crawler?

No. Well, you can but once you do things will not work correctly. We automatically create a default crawler that is associated with your DocSearch application and deleting it with the intention of creating a new one will not work as expected.

## What if I delete my DocSearch Crawler?

The fastest way will be to connect with us on our [Discord](https://alg.li/discord). Alternatively, email us at the address below and we will get to it as soon as we can.

## Links related to the migration

- [Docusaurus blog post](https://docusaurus.io/blog/2021/11/21/algolia-docsearch-migration)
Expand Down
21 changes: 9 additions & 12 deletions packages/website/docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,16 @@ We worked with **documentation website generators** to have DocSearch directly e
So, if you're using one of the following tools, checkout their documentation to see how to enable DocSearch on your website:

- [Docusaurus v1][1] - [How to enable search][2]
- [Docusaurus v2][3] - [Using Algolia DocSearch][4]
- [Docusaurus v2 & v3][3] - [Using Algolia DocSearch][4]
- [VuePress][5] - [Algolia Search][6]
- [VitePress][21] - [Search][22]
- [pkgdown][7] - [DocSearch indexing][8]
- [LaRecipe][9] - [Algolia Search][10]
- [Orchid][11] - [Algolia Search][12]
- [Smooth DOC][13] - [DocSearch][14]
- [Docsy][15] - [Configure Algolia DocSearch][16]
- [dumi][17] - [algolia][18]
- [Lotus Docs][19] - [Enabling the DocSearch Plugin][20]
- [Sphinx](https://www.sphinx-doc.org/en/master/) - [Algolia DocSearch for Sphinx](https://sphinx-docsearch.readthedocs.io/en/latest/)
- [Sphinx](https://www.sphinx-doc.org/en/master/) - [Algolia DocSearch for Sphinx](https://sphinx-docsearch.readthedocs.io/)

If you're maintaining a similar tool and want us to add you to the list, [feel free to make a pull request](https://github.com/algolia/docsearch/edit/main/packages/website/docs/integrations.md) and [contribute to Code Exchange](https://www.algolia.com/developers/code-exchange/contribute/). We're happy to help.

Expand All @@ -30,18 +29,16 @@ If you're maintaining a similar tool and want us to add you to the list, [feel f
[5]: https://vuepress.vuejs.org/
[6]: https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search
[7]: https://pkgdown.r-lib.org/
[8]: https://pkgdown.r-lib.org/articles/search.html
[9]: https://larecipe.binarytorch.com.my/docs/2.2/overview
[10]: https://larecipe.binarytorch.com.my/docs/2.2/configurations#search
[8]: https://pkgdown.r-lib.org/articles/search.html#bootstrap-3-algolia
[9]: https://larecipe.saleem.dev/docs/2.2/overview
[10]: https://larecipe.saleem.dev/docs/2.2/search#available-engines
[11]: https://orchid.run
[12]: https://orchid.run/plugins/orchidsearch#algolia-docsearch
[13]: https://smooth-doc.com/
[14]: https://smooth-doc.com/docs/docsearch/
[13]: https://next-smooth-doc.vercel.app/
[14]: https://next-smooth-doc.vercel.app/docs/docsearch/
[15]: https://www.docsy.dev/
[16]: https://www.docsy.dev/docs/adding-content/navigation/#configure-algolia-docsearch
[17]: https://d.umijs.org/
[18]: https://d.umijs.org/config#algolia
[16]: https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch
[19]: https://lotusdocs.dev/docs/
[20]: https://lotusdocs.dev/docs/guides/features/docsearch/#enabling-the-docsearch-plugin
[21]: https://vitepress.dev/
[22]: https://vitepress.dev/reference/default-theme-search#search
[22]: https://vitepress.dev/reference/default-theme-search#algolia-search
5 changes: 5 additions & 0 deletions packages/website/src/components/showcase-projects.json
Original file line number Diff line number Diff line change
Expand Up @@ -253,5 +253,10 @@
"name": "Fylgja",
"image": "img/logos/fylgja.svg",
"href": "https://fylgja.dev/"
},
{
"name": "React-admin",
"image": "img/logos/react-admin.svg",
"href": "https://marmelab.com/react-admin/"
}
]
9 changes: 8 additions & 1 deletion packages/website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,17 @@ html[data-theme='dark'] {
--ifm-menu-color-background-active: #21243d;
}

/* override to fix some logo placement issues due to flex auto */
.navbar__logo {
flex: 0 0 100%;
height: 2rem;
margin-right: 0.5rem;
}

/* DocSearch x Algolia logo */
@media (max-width: 565px) {
.navbar__logo .docsearch-nav-logo {
width: 22%;
width: 70%;
height: auto;
vertical-align: middle;
}
Expand Down
17 changes: 17 additions & 0 deletions packages/website/static/img/logos/react-admin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a3eefa7

Please sign in to comment.