Skip to content

Algolia の DocSearch を導入する #399

Closed
@yasulab

Description

@yasulab

DocSearch の利用申請は通りました 😆🎉✨ なのであとは実装するだけ 🔧 💨
実装にもし興味あればぜひ...!! ;) cc/ @odlovesq @chicaco

 

image

We're kind of scratching our own itch here. As developers, we spend a lot of time reading documentation, and it isn’t always easy to find the information we need.

No one's to blame, building a good search is a complex challenge. We just happen to have a lot of experience doing that, and we want to share it with the developer community.

cf. DocSearch: Search made for documentation

Who can apply?

cf. https://community.algolia.com/docsearch/who-can-apply.html

The checklist

To have your request validated, we'll ask that you validate all the following points.


You must be the owner of the website, or at least have the power to update its content. You'll have to include a JavaScript snippet to enable DocSearch.

Your website must be publicly available. We do not host index for websites that are available behind an authentication or a private network.

Your website must be a documentation website. We do not index blogs or commercial content.

Your website must have some final content. We won't index empty websites nor those filled with lorem ipsum placeholder content. Please, wait until you have written some documentation before applying. We would be happy to help you as soon as you have a steady design.


Even if we cannot accept your request, this does not mean that you cannot enjoy great search on your website.

DocSearch is entirely open source and you can run it yourself, or use any of our other API clients to take advantage of Algolia's features.

📮 🏃💨 Application

image

Refer to Algolia's Privacy Policy for more information on how we use and protect your data

Done! ✅

image

結果 => 🎉

Hi Yohei 👋

Thanks for your interest! This is great news to know that you'd like to entrust your search to DocSearch. A good search experience is key to help your users discover your content.

DocSearch is built in two parts:

  • a crawler which we run on our own infrastructure every 24 hours. It follows every link in your website and extract content from every page it traverses. It then pushes this content to an Algolia index.
  • a JavaScript snippet to be inserted in your website that will bind this Algolia index to your search input and display its results in a dropdown UI.

If you want to find more details on how works DocSearch, check our docs.

For implementing the search auto-complete of DocSearch, you'll need to insert a small JavaScript snippet in the page: are you able to do that?
Are you a maintainer of the website? Please confirm by replying this email.

Let us know if you have any other questions.
Have a great day,

The DocSearch team.
DocSearch is powered by Algolia

返信 from @yasulab 📨

Thanks for approving our request for DocSearch!
DocSearch will be helpful for CoderDojo communities in Japan!!

And to clarify that I am a maintainer, I am replying this email as yohei@coderdojo.jp
If I need to file any other information to clarify, feel free to let us know it. ;)

Best,
Yohei

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions