feat(docs): migrate documentation site into monorepo (#5912)
This commit is contained in:
1 parent
3e464a76f2
commit
9e421c67bd
605 files changed
+26764
-219
No files matched your search
@@ -0,0 +1,122 @@
|
||||
// Algolia DocSearch crawler for homarr.dev
|
||||
// Crawler ID: cd77a285-2756-4557-bf21-ee703748df15
|
||||
// DocSearch-managed crawlers: paste this in the Algolia crawler editor or send to DocSearch support.
|
||||
// Template: https://docsearch.algolia.com/docs/templates/#docusaurus-v3-template
|
||||
// Markdown indexing: https://www.algolia.com/doc/guides/algolia-ai/askai/guides/markdown-indexing
|
||||
|
||||
new Crawler({
|
||||
appId: "N69WSPZTID",
|
||||
apiKey: "YOUR_CRAWLER_ADMIN_API_KEY",
|
||||
rateLimit: 8,
|
||||
maxDepth: 10,
|
||||
startUrls: ["https://homarr.dev/"],
|
||||
sitemaps: ["https://homarr.dev/sitemap.xml"],
|
||||
ignoreCanonicalTo: true,
|
||||
discoveryPatterns: ["https://homarr.dev/**"],
|
||||
actions: [
|
||||
{
|
||||
indexName: "Docusaurus",
|
||||
pathsToMatch: ["https://homarr.dev/**"],
|
||||
recordExtractor: ({ $, helpers }) => {
|
||||
const lvl0 =
|
||||
$(".menu__link.menu__link--sublist.menu__link--active, .navbar__item.navbar__link--active").last().text() ||
|
||||
"Documentation";
|
||||
|
||||
return helpers.docsearch({
|
||||
recordProps: {
|
||||
lvl0: {
|
||||
selectors: "",
|
||||
defaultValue: lvl0,
|
||||
},
|
||||
lvl1: ["header h1", "article h1"],
|
||||
lvl2: "article h2",
|
||||
lvl3: "article h3",
|
||||
lvl4: "article h4",
|
||||
lvl5: "article h5, article td:first-child",
|
||||
lvl6: "article h6",
|
||||
content: "article p, article li, article td:last-child",
|
||||
},
|
||||
indexHeadings: true,
|
||||
aggregateContent: true,
|
||||
recordVersion: "v3",
|
||||
});
|
||||
},
|
||||
},
|
||||
{
|
||||
indexName: "markdown",
|
||||
pathsToMatch: ["https://homarr.dev/**"],
|
||||
recordExtractor: ({ $, url, helpers }) => {
|
||||
const text = helpers.markdown("article > *:not(nav):not(header):not(.breadcrumb)");
|
||||
|
||||
if (text === "") {
|
||||
return [];
|
||||
}
|
||||
|
||||
const language = $("html").attr("lang") || "en";
|
||||
const title = $("head > title").text();
|
||||
const h1 = $("article h1").first().text();
|
||||
|
||||
return helpers.splitTextIntoRecords({
|
||||
text,
|
||||
baseRecord: {
|
||||
url,
|
||||
objectID: url,
|
||||
title: title || h1,
|
||||
heading: h1,
|
||||
lang: language,
|
||||
language,
|
||||
version: "current",
|
||||
docusaurus_tag: "docs-default-current",
|
||||
},
|
||||
maxRecordBytes: 100000,
|
||||
orderingAttributeName: "part",
|
||||
});
|
||||
},
|
||||
},
|
||||
],
|
||||
initialIndexSettings: {
|
||||
Docusaurus: {
|
||||
attributesForFaceting: ["type", "lang", "language", "version", "docusaurus_tag"],
|
||||
attributesToRetrieve: ["hierarchy", "content", "anchor", "url", "url_without_anchor", "type"],
|
||||
attributesToHighlight: ["hierarchy", "content"],
|
||||
attributesToSnippet: ["content:10"],
|
||||
camelCaseAttributes: ["hierarchy", "content"],
|
||||
searchableAttributes: [
|
||||
"unordered(hierarchy.lvl0)",
|
||||
"unordered(hierarchy.lvl1)",
|
||||
"unordered(hierarchy.lvl2)",
|
||||
"unordered(hierarchy.lvl3)",
|
||||
"unordered(hierarchy.lvl4)",
|
||||
"unordered(hierarchy.lvl5)",
|
||||
"unordered(hierarchy.lvl6)",
|
||||
"content",
|
||||
],
|
||||
distinct: true,
|
||||
attributeForDistinct: "url",
|
||||
customRanking: ["desc(weight.pageRank)", "desc(weight.level)", "asc(weight.position)"],
|
||||
ranking: ["words", "filters", "typo", "attribute", "proximity", "exact", "custom"],
|
||||
highlightPreTag: '<span class="algolia-docsearch-suggestion--highlight">',
|
||||
highlightPostTag: "</span>",
|
||||
minWordSizefor1Typo: 3,
|
||||
minWordSizefor2Typos: 7,
|
||||
allowTyposOnNumericTokens: false,
|
||||
minProximity: 1,
|
||||
ignorePlurals: true,
|
||||
advancedSyntax: true,
|
||||
attributeCriteriaComputedByMinProximity: true,
|
||||
removeWordsIfNoResults: "allOptional",
|
||||
separatorsToIndex: "_",
|
||||
},
|
||||
markdown: {
|
||||
attributesForFaceting: ["lang", "language", "version", "docusaurus_tag"],
|
||||
ignorePlurals: true,
|
||||
minProximity: 1,
|
||||
removeStopWords: false,
|
||||
searchableAttributes: ["title", "heading", "unordered(text)"],
|
||||
removeWordsIfNoResults: "lastWords",
|
||||
attributesToHighlight: ["title", "text"],
|
||||
typoTolerance: false,
|
||||
advancedSyntax: false,
|
||||
},
|
||||
},
|
||||
});
|
||||
Reference in new issue
Block a user