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