[{"data":1,"prerenderedAt":690},["ShallowReactive",2],{"content-en-\u002Fapi\u002Ftypes-and-options":3},{"id":4,"title":5,"body":6,"description":683,"extension":684,"meta":685,"navigation":645,"path":686,"seo":687,"stem":688,"__hash__":689},"content_en\u002Fapi\u002Ftypes-and-options.md","Types and Options",{"type":7,"value":8,"toc":673},"minimark",[9,13,18,64,80,92,96,107,203,315,319,354,362,366,444,450,454,495,499,558,561,599,604,608,611,669],[10,11,5],"h1",{"id":12},"types-and-options",[14,15,17],"h2",{"id":16},"hyogencontext","HyogenContext",[19,20,25],"pre",{"className":21,"code":22,"language":23,"meta":24,"style":24},"language-ts shiki shiki-themes github-light github-dark","type HyogenContext = Record\u003Cstring, unknown>\n","ts","",[26,27,28],"code",{"__ignoreMap":24},[29,30,33,37,41,44,47,51,55,58,61],"span",{"class":31,"line":32},"line",1,[29,34,36],{"class":35},"szBVR","type",[29,38,40],{"class":39},"sScJk"," HyogenContext",[29,42,43],{"class":35}," =",[29,45,46],{"class":39}," Record",[29,48,50],{"class":49},"sVt8B","\u003C",[29,52,54],{"class":53},"sj4cs","string",[29,56,57],{"class":49},", ",[29,59,60],{"class":53},"unknown",[29,62,63],{"class":49},">\n",[65,66,67,68,71,72,75,76,79],"p",{},"Plain object of template variables. Passed as the second argument to ",[26,69,70],{},"renderServer"," \u002F ",[26,73,74],{},"renderClient",", or via ",[26,77,78],{},"build({ context })",".",[65,81,82,83,86,87,79],{},"Bindings follow last-write-wins scoping: front matter, ",[26,84,85],{},"@hg"," declarations, and component props can override earlier values. See ",[88,89,91],"a",{"href":90},"\u002Fen\u002Fsyntax\u002Ffront-matter","Front matter",[14,93,95],{"id":94},"renderoptions","RenderOptions",[65,97,98,99,57,101,103,104,79],{},"Shared by ",[26,100,70],{},[26,102,74],{},", and ",[26,105,106],{},"build",[19,108,110],{"className":21,"code":109,"language":23,"meta":24,"style":24},"type RenderOptions = {\n  preserveFrontMatter?: boolean   \u002F\u002F default: false\n  preserveHgComments?: boolean    \u002F\u002F default: false\n  loader?: Loader\n  root?: string\n  path?: string\n  constrainToRoot?: boolean\n}\n",[26,111,112,124,141,154,165,176,186,197],{"__ignoreMap":24},[29,113,114,116,119,121],{"class":31,"line":32},[29,115,36],{"class":35},[29,117,118],{"class":39}," RenderOptions",[29,120,43],{"class":35},[29,122,123],{"class":49}," {\n",[29,125,127,131,134,137],{"class":31,"line":126},2,[29,128,130],{"class":129},"s4XuR","  preserveFrontMatter",[29,132,133],{"class":35},"?:",[29,135,136],{"class":53}," boolean",[29,138,140],{"class":139},"sJ8bj","   \u002F\u002F default: false\n",[29,142,144,147,149,151],{"class":31,"line":143},3,[29,145,146],{"class":129},"  preserveHgComments",[29,148,133],{"class":35},[29,150,136],{"class":53},[29,152,153],{"class":139},"    \u002F\u002F default: false\n",[29,155,157,160,162],{"class":31,"line":156},4,[29,158,159],{"class":129},"  loader",[29,161,133],{"class":35},[29,163,164],{"class":39}," Loader\n",[29,166,168,171,173],{"class":31,"line":167},5,[29,169,170],{"class":129},"  root",[29,172,133],{"class":35},[29,174,175],{"class":53}," string\n",[29,177,179,182,184],{"class":31,"line":178},6,[29,180,181],{"class":129},"  path",[29,183,133],{"class":35},[29,185,175],{"class":53},[29,187,189,192,194],{"class":31,"line":188},7,[29,190,191],{"class":129},"  constrainToRoot",[29,193,133],{"class":35},[29,195,196],{"class":53}," boolean\n",[29,198,200],{"class":31,"line":199},8,[29,201,202],{"class":49},"}\n",[204,205,206,222],"table",{},[207,208,209],"thead",{},[210,211,212,216,219],"tr",{},[213,214,215],"th",{},"Option",[213,217,218],{},"Default",[213,220,221],{},"Description",[223,224,225,241,259,272,288,301],"tbody",{},[210,226,227,233,238],{},[228,229,230],"td",{},[26,231,232],{},"preserveFrontMatter",[228,234,235],{},[26,236,237],{},"false",[228,239,240],{},"Keep YAML front matter in output Markdown",[210,242,243,248,252],{},[228,244,245],{},[26,246,247],{},"preserveHgComments",[228,249,250],{},[26,251,237],{},[228,253,254,255,258],{},"Keep ",[26,256,257],{},"\u003C!-- @hg -->"," blocks in output (debugging)",[210,260,261,266,269],{},[228,262,263],{},[26,264,265],{},"loader",[228,267,268],{},"Node default",[228,270,271],{},"Custom path resolver",[210,273,274,279,285],{},[228,275,276],{},[26,277,278],{},"root",[228,280,281,282],{},"from ",[26,283,284],{},".doc_root",[228,286,287],{},"Project root directory",[210,289,290,295,298],{},[228,291,292],{},[26,293,294],{},"path",[228,296,297],{},"entry path",[228,299,300],{},"Source file path for diagnostics",[210,302,303,308,312],{},[228,304,305],{},[26,306,307],{},"constrainToRoot",[228,309,281,310],{},[26,311,284],{},[228,313,314],{},"Restrict file access to root",[14,316,318],{"id":317},"serverrenderoptions","ServerRenderOptions",[19,320,322],{"className":21,"code":321,"language":23,"meta":24,"style":24},"type ServerRenderOptions = RenderOptions & {\n  serverContext?: HyogenContext\n}\n",[26,323,324,340,350],{"__ignoreMap":24},[29,325,326,328,331,333,335,338],{"class":31,"line":32},[29,327,36],{"class":35},[29,329,330],{"class":39}," ServerRenderOptions",[29,332,43],{"class":35},[29,334,118],{"class":39},[29,336,337],{"class":35}," &",[29,339,123],{"class":49},[29,341,342,345,347],{"class":31,"line":126},[29,343,344],{"class":129},"  serverContext",[29,346,133],{"class":35},[29,348,349],{"class":39}," HyogenContext\n",[29,351,352],{"class":31,"line":143},[29,353,202],{"class":49},[65,355,356,357,359,360,79],{},"Only for ",[26,358,70],{},". Merged into the render context on the server. Not available on ",[26,361,74],{},[14,363,365],{"id":364},"buildoptions","BuildOptions",[19,367,369],{"className":21,"code":368,"language":23,"meta":24,"style":24},"type BuildOptions = RenderOptions & {\n  input: string | string[]\n  outDir: string\n  includeUnderscoreEntries?: boolean\n  context?: HyogenContext\n  serverContext?: HyogenContext\n}\n",[26,370,371,386,405,414,423,432,440],{"__ignoreMap":24},[29,372,373,375,378,380,382,384],{"class":31,"line":32},[29,374,36],{"class":35},[29,376,377],{"class":39}," BuildOptions",[29,379,43],{"class":35},[29,381,118],{"class":39},[29,383,337],{"class":35},[29,385,123],{"class":49},[29,387,388,391,394,397,400,402],{"class":31,"line":126},[29,389,390],{"class":129},"  input",[29,392,393],{"class":35},":",[29,395,396],{"class":53}," string",[29,398,399],{"class":35}," |",[29,401,396],{"class":53},[29,403,404],{"class":49},"[]\n",[29,406,407,410,412],{"class":31,"line":143},[29,408,409],{"class":129},"  outDir",[29,411,393],{"class":35},[29,413,175],{"class":53},[29,415,416,419,421],{"class":31,"line":156},[29,417,418],{"class":129},"  includeUnderscoreEntries",[29,420,133],{"class":35},[29,422,196],{"class":53},[29,424,425,428,430],{"class":31,"line":167},[29,426,427],{"class":129},"  context",[29,429,133],{"class":35},[29,431,349],{"class":39},[29,433,434,436,438],{"class":31,"line":178},[29,435,344],{"class":129},[29,437,133],{"class":35},[29,439,349],{"class":39},[29,441,442],{"class":31,"line":188},[29,443,202],{"class":49},[65,445,446,447,79],{},"See ",[88,448,106],{"href":449},"\u002Fen\u002Fapi\u002Fbuild",[14,451,453],{"id":452},"renderresult","RenderResult",[19,455,457],{"className":21,"code":456,"language":23,"meta":24,"style":24},"type RenderResult = {\n  markdown: string\n  warnings: HyogenWarning[]\n}\n",[26,458,459,470,479,491],{"__ignoreMap":24},[29,460,461,463,466,468],{"class":31,"line":32},[29,462,36],{"class":35},[29,464,465],{"class":39}," RenderResult",[29,467,43],{"class":35},[29,469,123],{"class":49},[29,471,472,475,477],{"class":31,"line":126},[29,473,474],{"class":129},"  markdown",[29,476,393],{"class":35},[29,478,175],{"class":53},[29,480,481,484,486,489],{"class":31,"line":143},[29,482,483],{"class":129},"  warnings",[29,485,393],{"class":35},[29,487,488],{"class":39}," HyogenWarning",[29,490,404],{"class":49},[29,492,493],{"class":31,"line":156},[29,494,202],{"class":49},[14,496,498],{"id":497},"buildresult","BuildResult",[19,500,502],{"className":21,"code":501,"language":23,"meta":24,"style":24},"type BuildResult = {\n  files: { path: string; markdown: string }[]\n  warnings: HyogenWarning[]\n}\n",[26,503,504,515,544,554],{"__ignoreMap":24},[29,505,506,508,511,513],{"class":31,"line":32},[29,507,36],{"class":35},[29,509,510],{"class":39}," BuildResult",[29,512,43],{"class":35},[29,514,123],{"class":49},[29,516,517,520,522,525,527,529,531,534,537,539,541],{"class":31,"line":126},[29,518,519],{"class":129},"  files",[29,521,393],{"class":35},[29,523,524],{"class":49}," { ",[29,526,294],{"class":129},[29,528,393],{"class":35},[29,530,396],{"class":53},[29,532,533],{"class":49},"; ",[29,535,536],{"class":129},"markdown",[29,538,393],{"class":35},[29,540,396],{"class":53},[29,542,543],{"class":49}," }[]\n",[29,545,546,548,550,552],{"class":31,"line":143},[29,547,483],{"class":129},[29,549,393],{"class":35},[29,551,488],{"class":39},[29,553,404],{"class":49},[29,555,556],{"class":31,"line":156},[29,557,202],{"class":49},[14,559,560],{"id":265},"Loader",[19,562,564],{"className":21,"code":563,"language":23,"meta":24,"style":24},"type Loader = (path: string) => Promise\u003Cstring>\n",[26,565,566],{"__ignoreMap":24},[29,567,568,570,573,575,578,580,582,584,587,590,593,595,597],{"class":31,"line":32},[29,569,36],{"class":35},[29,571,572],{"class":39}," Loader",[29,574,43],{"class":35},[29,576,577],{"class":49}," (",[29,579,294],{"class":129},[29,581,393],{"class":35},[29,583,396],{"class":53},[29,585,586],{"class":49},") ",[29,588,589],{"class":35},"=>",[29,591,592],{"class":39}," Promise",[29,594,50],{"class":49},[29,596,54],{"class":53},[29,598,63],{"class":49},[65,600,446,601,79],{},[88,602,560],{"href":603},"\u002Fen\u002Fapi\u002Floader",[14,605,607],{"id":606},"input-shapes","Input shapes",[65,609,610],{},"Both render functions accept:",[19,612,614],{"className":21,"code":613,"language":23,"meta":24,"style":24},"\u002F\u002F inline source\nrenderServer('# {{ title }}', { title: 'Hi' })\n\n\u002F\u002F file path (loaded via loader)\nrenderServer({ path: '.\u002Fpages\u002Findex.md' }, { title: 'Hi' })\n",[26,615,616,621,641,647,652],{"__ignoreMap":24},[29,617,618],{"class":31,"line":32},[29,619,620],{"class":139},"\u002F\u002F inline source\n",[29,622,623,625,628,632,635,638],{"class":31,"line":126},[29,624,70],{"class":39},[29,626,627],{"class":49},"(",[29,629,631],{"class":630},"sZZnC","'# {{ title }}'",[29,633,634],{"class":49},", { title: ",[29,636,637],{"class":630},"'Hi'",[29,639,640],{"class":49}," })\n",[29,642,643],{"class":31,"line":143},[29,644,646],{"emptyLinePlaceholder":645},true,"\n",[29,648,649],{"class":31,"line":156},[29,650,651],{"class":139},"\u002F\u002F file path (loaded via loader)\n",[29,653,654,656,659,662,665,667],{"class":31,"line":167},[29,655,70],{"class":39},[29,657,658],{"class":49},"({ path: ",[29,660,661],{"class":630},"'.\u002Fpages\u002Findex.md'",[29,663,664],{"class":49}," }, { title: ",[29,666,637],{"class":630},[29,668,640],{"class":49},[670,671,672],"style",{},"html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}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 .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}",{"title":24,"searchDepth":126,"depth":126,"links":674},[675,676,677,678,679,680,681,682],{"id":16,"depth":126,"text":17},{"id":94,"depth":126,"text":95},{"id":317,"depth":126,"text":318},{"id":364,"depth":126,"text":365},{"id":452,"depth":126,"text":453},{"id":497,"depth":126,"text":498},{"id":265,"depth":126,"text":560},{"id":606,"depth":126,"text":607},"HyogenContext, RenderOptions, BuildOptions, and result types.","md",{},"\u002Fapi\u002Ftypes-and-options",{"title":5,"description":683},"api\u002Ftypes-and-options","AmXkpBWuO2RaS7pmQEAhdYOvQBNdEqNPGhv5ouQWTgs",1787223114755]