[{"data":1,"prerenderedAt":645},["ShallowReactive",2],{"navigation":3,"api-navigation":109,"\u002Fdocs\u002Fsearch":110,"docyard:crossref-index":635},[4,14,97,101,105],{"title":5,"path":6,"stem":7,"children":8,"page":13},"Authoring","\u002Fauthoring","authoring",[9],{"title":10,"path":11,"stem":12},"Markdoc","\u002Fauthoring\u002Fmarkdoc","authoring\u002Fmarkdoc",false,{"title":15,"path":16,"stem":17,"children":18},"Docs","\u002Fdocs","docs",[19,22,26,30,34,55,59,63,93],{"title":20,"path":16,"stem":21},"Documentation","docs\u002Findex",{"title":23,"path":24,"stem":25},"Getting Started","\u002Fdocs\u002Fgetting-started","docs\u002F1.getting-started",{"title":27,"path":28,"stem":29},"Flake Module","\u002Fdocs\u002Fflake-module","docs\u002F2.flake-module",{"title":31,"path":32,"stem":33},"CLI Reference","\u002Fdocs\u002Fcli","docs\u002F3.cli",{"title":5,"path":35,"stem":36,"children":37},"\u002Fdocs\u002Fauthoring","docs\u002F4.authoring\u002Findex",[38,39,43,47,51],{"title":5,"path":35,"stem":36},{"title":40,"path":41,"stem":42},"Quarto Files","\u002Fdocs\u002Fauthoring\u002Fquarto","docs\u002F4.authoring\u002F1.quarto",{"title":44,"path":45,"stem":46},"Citations","\u002Fdocs\u002Fauthoring\u002Fcitations","docs\u002F4.authoring\u002F2.citations",{"title":48,"path":49,"stem":50},"Callouts","\u002Fdocs\u002Fauthoring\u002Fcallouts","docs\u002F4.authoring\u002F3.callouts",{"title":52,"path":53,"stem":54},"Cross-References","\u002Fdocs\u002Fauthoring\u002Fcross-references","docs\u002F4.authoring\u002F4.cross-references",{"title":56,"path":57,"stem":58},"Deployment","\u002Fdocs\u002Fdeployment","docs\u002F5.deployment",{"title":60,"path":61,"stem":62},"Search","\u002Fdocs\u002Fsearch","docs\u002F6.search",{"title":64,"path":65,"stem":66,"children":67},"Comparisons","\u002Fdocs\u002Fcomparison","docs\u002F7.comparison\u002Findex",[68,69,73,77,81,85,89],{"title":64,"path":65,"stem":66},{"title":70,"path":71,"stem":72},"Docyard vs. Docusaurus","\u002Fdocs\u002Fcomparison\u002Fdocusaurus","docs\u002F7.comparison\u002F1.docusaurus",{"title":74,"path":75,"stem":76},"Docyard vs. Sphinx","\u002Fdocs\u002Fcomparison\u002Fsphinx","docs\u002F7.comparison\u002F2.sphinx",{"title":78,"path":79,"stem":80},"Docyard vs. MkDocs","\u002Fdocs\u002Fcomparison\u002Fmkdocs","docs\u002F7.comparison\u002F3.mkdocs",{"title":82,"path":83,"stem":84},"Docyard vs. VitePress","\u002Fdocs\u002Fcomparison\u002Fvitepress","docs\u002F7.comparison\u002F4.vitepress",{"title":86,"path":87,"stem":88},"Docyard vs. Starlight","\u002Fdocs\u002Fcomparison\u002Fstarlight","docs\u002F7.comparison\u002F5.starlight",{"title":90,"path":91,"stem":92},"Docyard vs. GitBook","\u002Fdocs\u002Fcomparison\u002Fgitbook","docs\u002F7.comparison\u002F6.gitbook",{"title":94,"path":95,"stem":96},"Accessibility","\u002Fdocs\u002Faccessibility","docs\u002F8.accessibility",{"title":98,"path":99,"stem":100},"Docyard","\u002F","index",{"title":102,"path":103,"stem":104},"Notebook Demo","\u002Fnotebook-demo","notebook-demo",{"title":106,"path":107,"stem":108},"References","\u002Freferences","references",[],{"id":111,"title":60,"body":112,"description":629,"extension":630,"meta":631,"navigation":632,"path":61,"seo":633,"stem":62,"__hash__":634},"content\u002Fdocs\u002F6.search.md",{"type":113,"value":114,"toc":624},"minimark",[115,119,138,211,214,219,312,315,318,326,383,389,412,418,453,457,465,600,603,620],[116,117,60],"h1",{"id":118},"search",[120,121,122,123,127,128,131,132,137],"p",{},"Docyard ships with three search backends. The active one is selected with\n",[124,125,126],"code",{},"docyard.search.backend"," in your site's ",[124,129,130],{},"app.config.ts"," (or, in\n",[133,134,136],"a",{"href":135},"\u002Fdocs\u002Fflake-module#docyardsitesearchbackend","managed mode",", via the flake\noption). The default keeps the existing behavior, so no change is needed unless\nyou opt in.",[139,140,141,160],"table",{},[142,143,144],"thead",{},[145,146,147,151,154,157],"tr",{},[148,149,150],"th",{},"Backend",[148,152,153],{},"Index built",[148,155,156],{},"Server needed",[148,158,159],{},"Best for",[161,162,163,180,196],"tbody",{},[145,164,165,171,174,177],{},[166,167,168],"td",{},[124,169,170],{},"content",[166,172,173],{},"at runtime",[166,175,176],{},"no¹",[166,178,179],{},"development and small sites (the default)",[145,181,182,187,190,193],{},[166,183,184],{},[124,185,186],{},"pagefind",[166,188,189],{},"at build",[166,191,192],{},"no",[166,194,195],{},"large, fully static deployments",[145,197,198,203,206,208],{},[166,199,200],{},[124,201,202],{},"algolia",[166,204,205],{},"hosted",[166,207,192],{},[166,209,210],{},"projects already using Algolia DocSearch",[120,212,213],{},"¹ The built-in search downloads the full Nuxt Content SQLite database to the\nbrowser on first use, which grows with the site.",[215,216,218],"h2",{"id":217},"built-in-default","Built-in (default)",[220,221,226],"pre",{"className":222,"code":223,"filename":130,"language":224,"meta":225,"style":225},"language-ts shiki shiki-themes material-theme-lighter github-light github-dark","export default defineAppConfig({\n  docyard: {\n    search: { backend: \"content\" },\n  },\n});\n","ts","",[124,227,228,252,265,294,300],{"__ignoreMap":225},[229,230,233,237,240,244,248],"span",{"class":231,"line":232},"line",1,[229,234,236],{"class":235},"sVHd0","export",[229,238,239],{"class":235}," default",[229,241,243],{"class":242},"sGLFI"," defineAppConfig",[229,245,247],{"class":246},"su5hD","(",[229,249,251],{"class":250},"sP7_E","{\n",[229,253,255,259,262],{"class":231,"line":254},2,[229,256,258],{"class":257},"skxfh","  docyard",[229,260,261],{"class":250},":",[229,263,264],{"class":250}," {\n",[229,266,268,271,273,276,279,281,285,288,291],{"class":231,"line":267},3,[229,269,270],{"class":257},"    search",[229,272,261],{"class":250},[229,274,275],{"class":250}," {",[229,277,278],{"class":257}," backend",[229,280,261],{"class":250},[229,282,284],{"class":283},"sjJ54"," \"",[229,286,170],{"class":287},"s_sjI",[229,289,290],{"class":283},"\"",[229,292,293],{"class":250}," },\n",[229,295,297],{"class":231,"line":296},4,[229,298,299],{"class":250},"  },\n",[229,301,303,306,309],{"class":231,"line":302},5,[229,304,305],{"class":250},"}",[229,307,308],{"class":246},")",[229,310,311],{"class":250},";\n",[120,313,314],{},"Nothing to install. Search runs entirely client-side over the content database.",[215,316,317],{"id":186},"Pagefind",[120,319,320,325],{},[133,321,317],{"href":322,"rel":323},"https:\u002F\u002Fpagefind.app\u002F",[324],"nofollow"," builds a tiny static index after the site is\nprerendered and ships a small WASM runtime — no server, works on any static host\n(GitHub Pages, Cloudflare Pages, …).",[220,327,329],{"className":222,"code":328,"filename":130,"language":224,"meta":225,"style":225},"export default defineAppConfig({\n  docyard: {\n    search: { backend: \"pagefind\" },\n  },\n});\n",[124,330,331,343,351,371,375],{"__ignoreMap":225},[229,332,333,335,337,339,341],{"class":231,"line":232},[229,334,236],{"class":235},[229,336,239],{"class":235},[229,338,243],{"class":242},[229,340,247],{"class":246},[229,342,251],{"class":250},[229,344,345,347,349],{"class":231,"line":254},[229,346,258],{"class":257},[229,348,261],{"class":250},[229,350,264],{"class":250},[229,352,353,355,357,359,361,363,365,367,369],{"class":231,"line":267},[229,354,270],{"class":257},[229,356,261],{"class":250},[229,358,275],{"class":250},[229,360,278],{"class":257},[229,362,261],{"class":250},[229,364,284],{"class":283},[229,366,186],{"class":287},[229,368,290],{"class":283},[229,370,293],{"class":250},[229,372,373],{"class":231,"line":296},[229,374,299],{"class":250},[229,376,377,379,381],{"class":231,"line":302},[229,378,305],{"class":250},[229,380,308],{"class":246},[229,382,311],{"class":250},[120,384,385,386,388],{},"Add ",[124,387,186],{}," to your site's dev dependencies:",[220,390,394],{"className":391,"code":392,"language":393,"meta":225,"style":225},"language-bash shiki shiki-themes material-theme-lighter github-light github-dark","bun add -D pagefind\n","bash",[124,395,396],{"__ignoreMap":225},[229,397,398,402,405,409],{"class":231,"line":232},[229,399,401],{"class":400},"sbgvK","bun",[229,403,404],{"class":287}," add",[229,406,408],{"class":407},"stzsN"," -D",[229,410,411],{"class":287}," pagefind\n",[120,413,414,415,417],{},"The theme runs ",[124,416,186],{}," against the prerendered output automatically at the\nend of the build — there is no extra build step to wire up.",[419,420,421,433],"ul",{},[422,423,424,428,429,432],"li",{},[425,426,427],"strong",{},"Managed mode:"," setting ",[124,430,431],{},"docyard.site.search.backend = \"pagefind\""," is all\nthat is required; the flake exports the build-time signal for you.",[422,434,435,438,439,442,443,446,447,449,450,452],{},[425,436,437],{},"Explicit mode:"," also set ",[124,440,441],{},"DOCYARD_SEARCH_BACKEND=pagefind"," when building,\ne.g. ",[124,444,445],{},"DOCYARD_SEARCH_BACKEND=pagefind nuxt generate",". A file-based\n",[124,448,130],{}," isn't visible to the build hook that runs Pagefind, so this\nenv var is what triggers the index build (the ",[124,451,130],{}," value still\ndrives the search UI).",[215,454,456],{"id":455},"algolia-docsearch","Algolia DocSearch",[120,458,459,464],{},[133,460,463],{"href":461,"rel":462},"https:\u002F\u002Fdocsearch.algolia.com\u002F",[324],"DocSearch"," is free for open-source projects.\nOnce your site is accepted into the program you receive an application ID, a\nsearch-only API key, and an index name:",[220,466,468],{"className":222,"code":467,"filename":130,"language":224,"meta":225,"style":225},"export default defineAppConfig({\n  docyard: {\n    search: {\n      backend: \"algolia\",\n      algolia: {\n        appId: \"XXXXXXXXXX\",\n        apiKey: \"0000000000search-only-key\",\n        indexName: \"my-project\",\n      },\n    },\n  },\n});\n",[124,469,470,482,490,498,514,523,540,557,574,580,586,591],{"__ignoreMap":225},[229,471,472,474,476,478,480],{"class":231,"line":232},[229,473,236],{"class":235},[229,475,239],{"class":235},[229,477,243],{"class":242},[229,479,247],{"class":246},[229,481,251],{"class":250},[229,483,484,486,488],{"class":231,"line":254},[229,485,258],{"class":257},[229,487,261],{"class":250},[229,489,264],{"class":250},[229,491,492,494,496],{"class":231,"line":267},[229,493,270],{"class":257},[229,495,261],{"class":250},[229,497,264],{"class":250},[229,499,500,503,505,507,509,511],{"class":231,"line":296},[229,501,502],{"class":257},"      backend",[229,504,261],{"class":250},[229,506,284],{"class":283},[229,508,202],{"class":287},[229,510,290],{"class":283},[229,512,513],{"class":250},",\n",[229,515,516,519,521],{"class":231,"line":302},[229,517,518],{"class":257},"      algolia",[229,520,261],{"class":250},[229,522,264],{"class":250},[229,524,526,529,531,533,536,538],{"class":231,"line":525},6,[229,527,528],{"class":257},"        appId",[229,530,261],{"class":250},[229,532,284],{"class":283},[229,534,535],{"class":287},"XXXXXXXXXX",[229,537,290],{"class":283},[229,539,513],{"class":250},[229,541,543,546,548,550,553,555],{"class":231,"line":542},7,[229,544,545],{"class":257},"        apiKey",[229,547,261],{"class":250},[229,549,284],{"class":283},[229,551,552],{"class":287},"0000000000search-only-key",[229,554,290],{"class":283},[229,556,513],{"class":250},[229,558,560,563,565,567,570,572],{"class":231,"line":559},8,[229,561,562],{"class":257},"        indexName",[229,564,261],{"class":250},[229,566,284],{"class":283},[229,568,569],{"class":287},"my-project",[229,571,290],{"class":283},[229,573,513],{"class":250},[229,575,577],{"class":231,"line":576},9,[229,578,579],{"class":250},"      },\n",[229,581,583],{"class":231,"line":582},10,[229,584,585],{"class":250},"    },\n",[229,587,589],{"class":231,"line":588},11,[229,590,299],{"class":250},[229,592,594,596,598],{"class":231,"line":593},12,[229,595,305],{"class":250},[229,597,308],{"class":246},[229,599,311],{"class":250},[120,601,602],{},"The API key is the public, search-only key and is safe to commit. Add the\nDocSearch client to your site's dependencies:",[220,604,606],{"className":391,"code":605,"language":393,"meta":225,"style":225},"bun add @docsearch\u002Fjs @docsearch\u002Fcss\n",[124,607,608],{"__ignoreMap":225},[229,609,610,612,614,617],{"class":231,"line":232},[229,611,401],{"class":400},[229,613,404],{"class":287},[229,615,616],{"class":287}," @docsearch\u002Fjs",[229,618,619],{"class":287}," @docsearch\u002Fcss\n",[621,622,623],"style",{},"html pre.shiki code .sVHd0, html code.shiki .sVHd0{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#D73A49;--shiki-default-font-style:inherit;--shiki-dark:#F97583;--shiki-dark-font-style:inherit}html pre.shiki code .sGLFI, html code.shiki .sGLFI{--shiki-light:#6182B8;--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .su5hD, html code.shiki .su5hD{--shiki-light:#90A4AE;--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sP7_E, html code.shiki .sP7_E{--shiki-light:#39ADB5;--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .skxfh, html code.shiki .skxfh{--shiki-light:#E53935;--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sjJ54, html code.shiki .sjJ54{--shiki-light:#39ADB5;--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .s_sjI, html code.shiki .s_sjI{--shiki-light:#91B859;--shiki-default:#032F62;--shiki-dark:#9ECBFF}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sbgvK, html code.shiki .sbgvK{--shiki-light:#E2931D;--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .stzsN, html code.shiki .stzsN{--shiki-light:#91B859;--shiki-default:#005CC5;--shiki-dark:#79B8FF}",{"title":225,"searchDepth":267,"depth":267,"links":625},[626,627,628],{"id":217,"depth":254,"text":218},{"id":186,"depth":254,"text":317},{"id":455,"depth":254,"text":456},"Choose between the built-in search, Pagefind static search, or Algolia DocSearch.","md",{},true,{"title":60,"description":629},"D4QjRZIo1tdEAFn86Xh77bDcWqbg-splb5fOwHl7VFQ",{"fig-authoring-example":636,"tbl-authoring-demo":638,"eq-authoring-energy":640,"fig-pipeline":642,"tbl-solvers":643,"eq-loss":644},{"kind":637,"number":232,"path":11},"fig",{"kind":639,"number":232,"path":11},"tbl",{"kind":641,"number":232,"path":11},"eq",{"kind":637,"number":232,"path":53},{"kind":639,"number":232,"path":53},{"kind":641,"number":232,"path":53},1784218148264]