New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Docsearch #977

Merged
merged 1 commit into from Nov 15, 2016

Conversation

Projects
None yet
2 participants
@maxiloc
Contributor

maxiloc commented Nov 15, 2016

@hzoo, Following #438, and the discussion you had by email with Remy from Algolia, here is the docsearch implementation

yyksljifwg

@pixelastic pixelastic referenced this pull request Nov 15, 2016

Closed

Add Algolia search #438

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 15, 2016

Member

Awesome!

Also was wondering if anything needs to be done to get keyboard shortcuts working (up and down arrows)

Member

hzoo commented Nov 15, 2016

Awesome!

Also was wondering if anything needs to be done to get keyboard shortcuts working (up and down arrows)

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 15, 2016

Member

Hm we have a lot of the same settings so if I type API I get
screen shot 2016-11-15 at 10 30 53 am

rather than anything under usage

screen shot 2016-11-15 at 10 30 16 am

Member

hzoo commented Nov 15, 2016

Hm we have a lot of the same settings so if I type API I get
screen shot 2016-11-15 at 10 30 53 am

rather than anything under usage

screen shot 2016-11-15 at 10 30 16 am

@maxiloc

This comment has been minimized.

Show comment
Hide comment
@maxiloc

maxiloc Nov 15, 2016

Contributor

@hzoo The up and down arrow are handled by default, but the yellow highlight was a bit to transparent. It should be better now.
There was a mistake in the docsearch config and the usage pages were not picked up correctly. It should be ok now.

Tell me if it's good for you.

Contributor

maxiloc commented Nov 15, 2016

@hzoo The up and down arrow are handled by default, but the yellow highlight was a bit to transparent. It should be better now.
There was a mistake in the docsearch config and the usage pages were not picked up correctly. It should be ok now.

Tell me if it's good for you.

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 15, 2016

Member

yeah it should be everything in https://github.com/babel/babel.github.io/tree/master/docs

looks better now
screen shot 2016-11-15 at 11 00 34 am

Member

hzoo commented Nov 15, 2016

yeah it should be everything in https://github.com/babel/babel.github.io/tree/master/docs

looks better now
screen shot 2016-11-15 at 11 00 34 am

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 15, 2016

Member

@maxiloc how does the config work or is that on your end? Was wondering how to get better results if we find there are issues. I'm cool to merge this now though

testing locally I see the url always points to the babeljs.io website but it's not a big deal

Member

hzoo commented Nov 15, 2016

@maxiloc how does the config work or is that on your end? Was wondering how to get better results if we find there are issues. I'm cool to merge this now though

testing locally I see the url always points to the babeljs.io website but it's not a big deal

@hzoo hzoo merged commit ea5226b into babel:master Nov 15, 2016

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 15, 2016

Member

Since it looks like the top level h1 isn't picked up. Like if I search polyfill I might expect that specific page to show up http://babeljs.io/docs/usage/polyfill

Member

hzoo commented Nov 15, 2016

Since it looks like the top level h1 isn't picked up. Like if I search polyfill I might expect that specific page to show up http://babeljs.io/docs/usage/polyfill

@maxiloc

This comment has been minimized.

Show comment
Hide comment
@maxiloc

maxiloc Nov 15, 2016

Contributor

You can have a look at the config here: https://github.com/algolia/docsearch-configs/blob/master/configs/babeljs.json. It's a set of simple rules that are used to crawl the website. You can make PRs if you need or just ping us when you see something that is not optimal and we'll fix it.

We then crawl the site automatically with https://github.com/algolia/docsearch-scraper

Contributor

maxiloc commented Nov 15, 2016

You can have a look at the config here: https://github.com/algolia/docsearch-configs/blob/master/configs/babeljs.json. It's a set of simple rules that are used to crawl the website. You can make PRs if you need or just ping us when you see something that is not optimal and we'll fix it.

We then crawl the site automatically with https://github.com/algolia/docsearch-scraper

@hzoo

This comment has been minimized.

Show comment
Hide comment
@hzoo

hzoo Nov 15, 2016

Member

Oh ok thanks a lot!

I was wondering given you added

  "start_urls": [
    "http://babeljs.io/docs/",
    "http://babeljs.io/docs/usage/api"
  ],

whether we need to add the rest https://github.com/babel/babel.github.io/tree/master/docs/usage

Member

hzoo commented Nov 15, 2016

Oh ok thanks a lot!

I was wondering given you added

  "start_urls": [
    "http://babeljs.io/docs/",
    "http://babeljs.io/docs/usage/api"
  ],

whether we need to add the rest https://github.com/babel/babel.github.io/tree/master/docs/usage

@maxiloc

This comment has been minimized.

Show comment
Hide comment
@maxiloc

maxiloc Nov 15, 2016

Contributor

I tweaked a bit the config the polyfill should appear first now

Contributor

maxiloc commented Nov 15, 2016

I tweaked a bit the config the polyfill should appear first now

@maxiloc

This comment has been minimized.

Show comment
Hide comment
@maxiloc

maxiloc Nov 15, 2016

Contributor

No we don't need to add it all urls manually. We have http://babeljs.io/docs/usage/api because http://babeljs.io/docs/ is a 404 but we need it to accept all http://babeljs.io/docs/* urls

Contributor

maxiloc commented Nov 15, 2016

No we don't need to add it all urls manually. We have http://babeljs.io/docs/usage/api because http://babeljs.io/docs/ is a 404 but we need it to accept all http://babeljs.io/docs/* urls

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment