algolia / docsearch-configs Goto Github PK
View Code? Open in Web Editor NEWDocSearch - Configurations
Home Page: https://docsearch.algolia.com/
License: MIT License
DocSearch - Configurations
Home Page: https://docsearch.algolia.com/
License: MIT License
The base reference manual: https://docs.puppet.com/puppet/latest
Note that Puppet Server, Hiera, and PuppetDB are split out into their own components (see https://docs.puppet.com/puppet/).
For https://thumbprint.thumbtack.com our lvl0
selector looks like:
"lvl0": {
"selector": "//*[@data-id='header__links']//a[@data-active='true']",
"type": "xpath",
"default_value": "Documentation"
},
https://github.com/algolia/docsearch-configs/blob/master/configs/thumbprint.json
When I search for the page title "Using Thumbprint in Sass" โ https://thumbprint.thumbtack.com/guide/creating-pages/ โ the search result correctly categorizes it under "Guide".
But if I search for the pages titles of the following pages:
It categorizes them under "Documentation" instead of "Guide".
In this screenshot "https://thumbprint.thumbtack.com/guide/utility-classes/" is among the results, note that it's categorized under "Documentation"
I've confirmed the lvl0
xpath works on those pages so am not sure what would have caused it to fail. Maybe your crawler searched cached pages that didn't have this selector available?
I love you for supporting nim-lang, but after trying the search I have to say: it's still not something that we can put on our website since the search results are too poor. For example, searching for 'split' doesn't contain a search result like http://nim-lang.org/docs/strutils.html#split,string,set[char],int
So lib.html is crawled, but none of actual Nim's stdlib. I would create a PR if only I knew how to do it.
More feature than bug
index_name
?index_name
= pkgdown
May R functions make use of ellipsis (...
) to catch arguments in function calls. In a pkgdown documentation website these appear in the Argument list (see third argument on this page).
We capture most arguments and their values with the current docsearch pkgdown config, but ellipsis are not indexed because they are considered punctuation.
I'd like ...
to be included in search results as an argument value.
I have tried including a period (.
) in separatorsToIndex
but the ellipsis are still not indexed.
Expected: first results include a reference to https://www.lightningdesignsystem.com/components/tiles/
Do you know why the actual "Tiles" component doesn't rank higher than other components, considering the h1 of the component page says "Tiles"?
Hi,
Here is my config file: https://github.com/algolia/docsearch-configs/blob/master/configs/uniwebview.json
I've changed my domain from "unidocs.onevcat.com" to "docs.uniwebview.com" several days ago. However, the navigation destination of search result are still pointing to the old domain.
I guess it is due to the old index in using and the new ones are not valid yet.
I want to confirm is there anything like expiring duration for index? What is the reindex policy and is it possible to request a reindex immediately?
Thanks!
Hi Algolia team !
I have a question about this configuration
https://github.com/algolia/docsearch-configs/blob/master/configs/akeneo.json
We will introduce a new design (same as https://api.akeneo.com/ ) for the v2.0 (the old design is still here : https://docs.akeneo.com/2.0/index.html)
So the parsing configuration between paths https://docs.akeneo.com/1.x/ and https://docs.akeneo.com/2.x/ will not be the same.
My question is: is it possible to have 2 configurations (one for 1.x and one for 2.x) ? If not, don't worry, we will bring back the new design for the previous 1.x paths.
Regars
Pierre
Akeneo
It would be useful for tracking and reporting purposes to have some fields in the configs that aren't necessarily used by the scraper. Immediately I'd like to add:
name
: Canonical, human-readable label (such as company or project name) for a given config.human_url
: A URL that a human could go to and get the documentation site.Hey, guys! I'm the maintainer of the babeljs.cn. I found that the docsearch of babeljs_cn was deleted, but I don 't know why. Please tell me why and how to solve it.
commit: e0cc0b8
hey all, I was hoping for some help updating the indexing for the drone_io documentation. We have moved the documentation:
{
"index_name": "drone_io",
"start_urls": [
- "http://readme.drone.io/"
+ "http://docs.drone.io/sitemap/"
],
We have also adjusted the structure. I was hoping that perhaps Algolia could crawl the documentation using the sitemap only (at http://docs.drone.io/sitemap/). This would allow us to make structural changes to the main documentation, without having to re-configure the crawling, since the sitemap structure would never change.
Do you think this would be possible?
I would offer to submit a pull request but was unsure if the below notation was correct, and I was having trouble setting up an environment to test myself (I will keep trying, though)
- "lvl0": "header nav a.selected",
- "lvl1": "main h1",
- "lvl2": "main h2",
+ "lvl0": "body > ul > li > span",
+ "lvl1": "body > ul > li > ul > li > span",
+ "lvl2": "body > ul > li > ul > li > ul > li > a",
It looks like a new parameter nb_hits_max
has been introduced to the scraper. It would be great if information regarding this parameter is included in the documentation here ๐
Search seems currently broken on https://ruby-doc.org/core/
If only they could add Docsearch to their build pipleline ๐
I am having a hard time figuring out what I need to configure so the scrapper can index the <code>
block on my site.
This site is uses the same template as me, how would I index the code listed in it: https://myclabs.github.io/jquery.confirm/
The output of {{{_highlightResult.content.value}}}
shows only text, as if the results were just a paragraph:
I don't know how to solve this, couldn't find anywhere - I'm probably searching for the wrong query.
@s-pace thoughts?
index_name
?index_name
= pkgdown
Files that are not in the sitemap.xml are included in the index.
Files that are not in the sitemap.xml should not be included in the index.
The pkgdown index includes the "Contributor Code of Conduct" page, which is not in the sitemap.xml.
To reproduce, go to the pkgdown website and search for "Contributor"; it's the first result.
The pkgdown config lists the sitemap.xml. Why is this page (and presumably other unwanted pages) included in the index?
If it's an existing config, run that one and suggest to update the nbHits
in a comment. You could use Danger for this, since it's an easy way to run some things and comment on GitHub.
Another thing that could be checked is whether it's valid JSON, and if it's a valid docsearch config (by checking if necessary keys are present, and if they have the right values)
There is a lot of nice content, but everything is hard to find.
Moved to private repo
As reported in tweet, configuration for Scalingo need an update.
https://dev.to/ben/what-are-some-examples-of-great-documentation/comments
Interesting list for potential DocSearch candidates.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.