Replies: 1 comment 5 replies
-
|
The code we use is entirely here: import {useCallback} from 'react';
import {isRegexpStringMatch} from '@docusaurus/theme-common';
import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
import {useAlgoliaThemeConfig} from './useAlgoliaThemeConfig';
import type {ThemeConfig} from '@docusaurus/theme-search-algolia';
function replacePathname(
pathname: string,
replaceSearchResultPathname: ThemeConfig['algolia']['replaceSearchResultPathname'],
): string {
return replaceSearchResultPathname
? pathname.replaceAll(
new RegExp(replaceSearchResultPathname.from, 'g'),
replaceSearchResultPathname.to,
)
: pathname;
}
/**
* Process the search result url from Algolia to its final form, ready to be
* navigated to or used as a link
*/
export function useSearchResultUrlProcessor(): (url: string) => string {
const {withBaseUrl} = useBaseUrlUtils();
const {
algolia: {externalUrlRegex, replaceSearchResultPathname},
} = useAlgoliaThemeConfig();
return useCallback(
(url: string) => {
const parsedURL = new URL(url);
// Algolia contains an external domain => navigate to URL
if (isRegexpStringMatch(externalUrlRegex, parsedURL.href)) {
return url;
}
// Otherwise => transform to relative URL for SPA navigation
const relativeUrl = `${parsedURL.pathname + parsedURL.hash}`;
return withBaseUrl(
replacePathname(relativeUrl, replaceSearchResultPathname),
);
},
[withBaseUrl, externalUrlRegex, replaceSearchResultPathname],
);
}
export function isRegexpStringMatch(
regexAsString?: string,
valueToTest?: string,
): boolean {
if (
typeof regexAsString === 'undefined' ||
typeof valueToTest === 'undefined'
) {
return false;
}
return new RegExp(regexAsString, 'gi').test(valueToTest);
}By default Docusaurus assumes that you index your own site, and doesn't know about other things. Note that technically Algolia allows you to index Docusaurus sites alongside any other thing (including things that are not even Docusaurus) and we can't document all these patterns, it's the responsibility of Algolia to do so. What we can do is only handle a default integration of Algolia, using the most common scenario: an index dedicate to a single Docusaurus site. If that doesn't work for your case, you can still swizzle and adjust the Algolia integration according to your needs, and eventually report back by suggestion a few options that you unlock your use-case. I believe the current options may be enough for your case: maybe when you are on site1, you could use function useNavigator({
externalUrlRegex,
}: Pick<DocSearchProps, 'externalUrlRegex'>) {
const history = useHistory();
const [navigator] = useState<DocSearchModalProps['navigator']>(() => {
return {
navigate(params) {
// Algolia results could contain URL's from other domains which cannot
// be served through history and should navigate with window.location
if (isRegexpStringMatch(externalUrlRegex, params.itemUrl)) {
window.location.href = params.itemUrl;
} else {
history.push(params.itemUrl);
}
},
};
});
return navigator;
} |
Beta Was this translation helpful? Give feedback.
-
I found
I managed to swizzle
I have to fix this somehow, so, if no other way, I'll try to do this. However I would need a bit of help to be able to do a minimal debugging. I'm currently using Safari, and I know how to check the JavaScript Console. Is there anything better than
If I understood this right, it defines which URLs should not be processed by Docusaurus. If so, I tried the extreme solution and defined all URLs in all related sites that are part of the Algolia index, and used this line: I need to test more thoroughly, but now searches from Are there any disadvantages of declaring all URLs as external? Or, on reversed logic, what are the advantages of allowing Docusaurus to process the URLs? |
Beta Was this translation helpful? Give feedback.
-
You don't need to: you can write your own if our default-provided logic doesn't work for your use-case. This Docusaurus function is only used to implement the DocSearch
I'm sorry but I can't help you on this, there are online resources where to learn how to debug things.
"processed by Docusaurus" is not clearly defined. As you can see from the code I pasted above, "external URLs" (a random term we invented, because we have to give a name to this option) permits to:
That's all. You can call this "processing" if you want to but that doesn't feel accurate to me. I don't know what you mean by "processing". And you can override any of this logic by writing your own code on swizzled component.
This means that when on site1, and docSearch returns a search hit from the same site1, it will not use It will use |
Beta Was this translation helpful? Give feedback.
-
Would it make any sense to have a configuration that does not process DocSearch hit URLs, but uses If so, how about a configuration like |
Beta Was this translation helpful? Give feedback.
-
I can only know if it makes sense if you explain your use case. What config would you use and why And what does the Algolia index contains |
Beta Was this translation helpful? Give feedback.
-
The Algolia index is the result of parsing two domains (xpack and xpack-dev-tools), each with multiple sitemaps, 27 all together (but more projects will be added). The crawler uses the following two robots.txt files: Since all sites are actually part of the xPack Project, the same index is used in all sites.
Currently all sites use the config recommended by the documentation, plus:
Why I use this multi-domain, multi-web configuration? Because it looked more natural for each project to have its own documentation in the same Git repo, with automatic rebuild and publish. Is this a stupid idea? Should I move all documentation pages under a single web site? My previous Jekyll web site used this monolitic approach, and it wasn't a joy to maintain. I thought that bringing the documentation closer to the code would be better. |
Beta Was this translation helpful? Give feedback.
-
I have several related sites, which, for administrative reasons, are published as separate GitHub Pages sites. For example:
Each has its own GitHub project and is automatically published on updates.
Algolia reads https://xpack.github.io/robots.txt, gets the list of sitemaps, and creates an index for the whole site. The index is used in the docusaurus.config.ts of each site, with the content recommended by the documentation.
If I search for terms while being in the top site, things seem more or less ok.
If, while being in one sub-site, I search for terms defined in another sub-site, the resulting links are wrong, they are always prefixed with the baseUrl of the current site.
For example, while being in xcdl, if I search for something in xpm, I get a link like:
instead of
Is there any way to configure the optional
externalUrlRegexand/orreplaceSearchResultPathnameto fix the problem?I tried to read the documentation several times, but the content is a bit too cryptic for me... :-(
Beta Was this translation helpful? Give feedback.
All reactions