[{"data":1,"prerenderedAt":782},["ShallowReactive",2],{"content-ja-\u002Fapi\u002Ftypes-and-options":3},{"id":4,"title":5,"body":6,"description":775,"extension":776,"meta":777,"navigation":490,"path":778,"seo":779,"stem":780,"__hash__":781},"content_ja\u002Fapi\u002Ftypes-and-options.md","型とオプション",{"type":7,"value":8,"toc":764},"minimark",[9,12,16,115,120,156,167,171,240,306,310,345,358,362,441,445,547,550,588,591,688,691,736,739,760],[10,11,5],"h1",{"id":5},[13,14,15],"p",{},"公開されている主要な型の要約です。TypeScript 利用時はパッケージから型を import できます。",[17,18,23],"pre",{"className":19,"code":20,"language":21,"meta":22,"style":22},"language-ts shiki shiki-themes github-light github-dark","import type {\n  HyogenContext,\n  HyogenDiagnostic,\n  HyogenError,\n  HyogenWarning,\n  Loader,\n  RenderOptions,\n  RenderResult,\n  ServerRenderOptions,\n  BuildOptions,\n  BuildResult,\n} from '@b4moss\u002Fhyogen-md'\n","ts","",[24,25,26,42,48,54,60,66,72,78,84,90,96,102],"code",{"__ignoreMap":22},[27,28,31,35,38],"span",{"class":29,"line":30},"line",1,[27,32,34],{"class":33},"szBVR","import",[27,36,37],{"class":33}," type",[27,39,41],{"class":40},"sVt8B"," {\n",[27,43,45],{"class":29,"line":44},2,[27,46,47],{"class":40},"  HyogenContext,\n",[27,49,51],{"class":29,"line":50},3,[27,52,53],{"class":40},"  HyogenDiagnostic,\n",[27,55,57],{"class":29,"line":56},4,[27,58,59],{"class":40},"  HyogenError,\n",[27,61,63],{"class":29,"line":62},5,[27,64,65],{"class":40},"  HyogenWarning,\n",[27,67,69],{"class":29,"line":68},6,[27,70,71],{"class":40},"  Loader,\n",[27,73,75],{"class":29,"line":74},7,[27,76,77],{"class":40},"  RenderOptions,\n",[27,79,81],{"class":29,"line":80},8,[27,82,83],{"class":40},"  RenderResult,\n",[27,85,87],{"class":29,"line":86},9,[27,88,89],{"class":40},"  ServerRenderOptions,\n",[27,91,93],{"class":29,"line":92},10,[27,94,95],{"class":40},"  BuildOptions,\n",[27,97,99],{"class":29,"line":98},11,[27,100,101],{"class":40},"  BuildResult,\n",[27,103,105,108,111],{"class":29,"line":104},12,[27,106,107],{"class":40},"} ",[27,109,110],{"class":33},"from",[27,112,114],{"class":113},"sZZnC"," '@b4moss\u002Fhyogen-md'\n",[116,117,119],"h2",{"id":118},"hyogencontext","HyogenContext",[17,121,123],{"className":19,"code":122,"language":21,"meta":22,"style":22},"type HyogenContext = Record\u003Cstring, unknown>\n",[24,124,125],{"__ignoreMap":22},[27,126,127,130,134,137,140,143,147,150,153],{"class":29,"line":30},[27,128,129],{"class":33},"type",[27,131,133],{"class":132},"sScJk"," HyogenContext",[27,135,136],{"class":33}," =",[27,138,139],{"class":132}," Record",[27,141,142],{"class":40},"\u003C",[27,144,146],{"class":145},"sj4cs","string",[27,148,149],{"class":40},", ",[27,151,152],{"class":145},"unknown",[27,154,155],{"class":40},">\n",[13,157,158,159,162,163,166],{},"テンプレート変数のマップです。",[24,160,161],{},"context","、",[24,164,165],{},"serverContext","、front matter、component の props がすべてこの形で束縛されます。",[116,168,170],{"id":169},"renderoptions","RenderOptions",[17,172,174],{"className":19,"code":173,"language":21,"meta":22,"style":22},"type RenderOptions = {\n  preserveFrontMatter?: boolean   \u002F\u002F デフォルト: false\n  preserveHgComments?: boolean    \u002F\u002F デフォルト: false\n  loader?: Loader\n  root?: string\n}\n",[24,175,176,187,203,215,225,235],{"__ignoreMap":22},[27,177,178,180,183,185],{"class":29,"line":30},[27,179,129],{"class":33},[27,181,182],{"class":132}," RenderOptions",[27,184,136],{"class":33},[27,186,41],{"class":40},[27,188,189,193,196,199],{"class":29,"line":44},[27,190,192],{"class":191},"s4XuR","  preserveFrontMatter",[27,194,195],{"class":33},"?:",[27,197,198],{"class":145}," boolean",[27,200,202],{"class":201},"sJ8bj","   \u002F\u002F デフォルト: false\n",[27,204,205,208,210,212],{"class":29,"line":50},[27,206,207],{"class":191},"  preserveHgComments",[27,209,195],{"class":33},[27,211,198],{"class":145},[27,213,214],{"class":201},"    \u002F\u002F デフォルト: false\n",[27,216,217,220,222],{"class":29,"line":56},[27,218,219],{"class":191},"  loader",[27,221,195],{"class":33},[27,223,224],{"class":132}," Loader\n",[27,226,227,230,232],{"class":29,"line":62},[27,228,229],{"class":191},"  root",[27,231,195],{"class":33},[27,233,234],{"class":145}," string\n",[27,236,237],{"class":29,"line":68},[27,238,239],{"class":40},"}\n",[241,242,243,256],"table",{},[244,245,246],"thead",{},[247,248,249,253],"tr",{},[250,251,252],"th",{},"オプション",[250,254,255],{},"説明",[257,258,259,270,283,293],"tbody",{},[247,260,261,267],{},[262,263,264],"td",{},[24,265,266],{},"preserveFrontMatter",[262,268,269],{},"レンダリング後の Markdown に YAML front matter を残す",[247,271,272,277],{},[262,273,274],{},[24,275,276],{},"preserveHgComments",[262,278,279,282],{},[24,280,281],{},"@hg"," ブロックの HTML コメントを出力に残す（デバッグ用）",[247,284,285,290],{},[262,286,287],{},[24,288,289],{},"loader",[262,291,292],{},"ファイル読み込み関数",[247,294,295,300],{},[262,296,297],{},[24,298,299],{},"root",[262,301,302,305],{},[24,303,304],{},".doc_root"," の代わりにドキュメントルートを指定",[116,307,309],{"id":308},"serverrenderoptions","ServerRenderOptions",[17,311,313],{"className":19,"code":312,"language":21,"meta":22,"style":22},"type ServerRenderOptions = RenderOptions & {\n  serverContext?: HyogenContext\n}\n",[24,314,315,331,341],{"__ignoreMap":22},[27,316,317,319,322,324,326,329],{"class":29,"line":30},[27,318,129],{"class":33},[27,320,321],{"class":132}," ServerRenderOptions",[27,323,136],{"class":33},[27,325,182],{"class":132},[27,327,328],{"class":33}," &",[27,330,41],{"class":40},[27,332,333,336,338],{"class":29,"line":44},[27,334,335],{"class":191},"  serverContext",[27,337,195],{"class":33},[27,339,340],{"class":132}," HyogenContext\n",[27,342,343],{"class":29,"line":50},[27,344,239],{"class":40},[13,346,347,350,351,354,355,357],{},[24,348,349],{},"renderServer"," と ",[24,352,353],{},"build"," のみ ",[24,356,165],{}," を受け取れます。",[116,359,361],{"id":360},"buildoptions","BuildOptions",[17,363,365],{"className":19,"code":364,"language":21,"meta":22,"style":22},"type BuildOptions = RenderOptions & {\n  input: string | string[]\n  outDir: string\n  includeUnderscoreEntries?: boolean\n  context?: HyogenContext\n  serverContext?: HyogenContext\n}\n",[24,366,367,382,401,410,420,429,437],{"__ignoreMap":22},[27,368,369,371,374,376,378,380],{"class":29,"line":30},[27,370,129],{"class":33},[27,372,373],{"class":132}," BuildOptions",[27,375,136],{"class":33},[27,377,182],{"class":132},[27,379,328],{"class":33},[27,381,41],{"class":40},[27,383,384,387,390,393,396,398],{"class":29,"line":44},[27,385,386],{"class":191},"  input",[27,388,389],{"class":33},":",[27,391,392],{"class":145}," string",[27,394,395],{"class":33}," |",[27,397,392],{"class":145},[27,399,400],{"class":40},"[]\n",[27,402,403,406,408],{"class":29,"line":50},[27,404,405],{"class":191},"  outDir",[27,407,389],{"class":33},[27,409,234],{"class":145},[27,411,412,415,417],{"class":29,"line":56},[27,413,414],{"class":191},"  includeUnderscoreEntries",[27,416,195],{"class":33},[27,418,419],{"class":145}," boolean\n",[27,421,422,425,427],{"class":29,"line":62},[27,423,424],{"class":191},"  context",[27,426,195],{"class":33},[27,428,340],{"class":132},[27,430,431,433,435],{"class":29,"line":68},[27,432,335],{"class":191},[27,434,195],{"class":33},[27,436,340],{"class":132},[27,438,439],{"class":29,"line":74},[27,440,239],{"class":40},[116,442,444],{"id":443},"renderresult-buildresult","RenderResult \u002F BuildResult",[17,446,448],{"className":19,"code":447,"language":21,"meta":22,"style":22},"type RenderResult = {\n  markdown: string\n  warnings: HyogenWarning[]\n}\n\ntype BuildResult = {\n  files: { path: string; markdown: string }[]\n  warnings: HyogenWarning[]\n}\n",[24,449,450,461,470,482,486,492,503,533,543],{"__ignoreMap":22},[27,451,452,454,457,459],{"class":29,"line":30},[27,453,129],{"class":33},[27,455,456],{"class":132}," RenderResult",[27,458,136],{"class":33},[27,460,41],{"class":40},[27,462,463,466,468],{"class":29,"line":44},[27,464,465],{"class":191},"  markdown",[27,467,389],{"class":33},[27,469,234],{"class":145},[27,471,472,475,477,480],{"class":29,"line":50},[27,473,474],{"class":191},"  warnings",[27,476,389],{"class":33},[27,478,479],{"class":132}," HyogenWarning",[27,481,400],{"class":40},[27,483,484],{"class":29,"line":56},[27,485,239],{"class":40},[27,487,488],{"class":29,"line":62},[27,489,491],{"emptyLinePlaceholder":490},true,"\n",[27,493,494,496,499,501],{"class":29,"line":68},[27,495,129],{"class":33},[27,497,498],{"class":132}," BuildResult",[27,500,136],{"class":33},[27,502,41],{"class":40},[27,504,505,508,510,513,516,518,520,523,526,528,530],{"class":29,"line":74},[27,506,507],{"class":191},"  files",[27,509,389],{"class":33},[27,511,512],{"class":40}," { ",[27,514,515],{"class":191},"path",[27,517,389],{"class":33},[27,519,392],{"class":145},[27,521,522],{"class":40},"; ",[27,524,525],{"class":191},"markdown",[27,527,389],{"class":33},[27,529,392],{"class":145},[27,531,532],{"class":40}," }[]\n",[27,534,535,537,539,541],{"class":29,"line":80},[27,536,474],{"class":191},[27,538,389],{"class":33},[27,540,479],{"class":132},[27,542,400],{"class":40},[27,544,545],{"class":29,"line":86},[27,546,239],{"class":40},[116,548,549],{"id":289},"Loader",[17,551,553],{"className":19,"code":552,"language":21,"meta":22,"style":22},"type Loader = (path: string) => Promise\u003Cstring>\n",[24,554,555],{"__ignoreMap":22},[27,556,557,559,562,564,567,569,571,573,576,579,582,584,586],{"class":29,"line":30},[27,558,129],{"class":33},[27,560,561],{"class":132}," Loader",[27,563,136],{"class":33},[27,565,566],{"class":40}," (",[27,568,515],{"class":191},[27,570,389],{"class":33},[27,572,392],{"class":145},[27,574,575],{"class":40},") ",[27,577,578],{"class":33},"=>",[27,580,581],{"class":132}," Promise",[27,583,142],{"class":40},[27,585,146],{"class":145},[27,587,155],{"class":40},[116,589,590],{"id":590},"診断型",[17,592,594],{"className":19,"code":593,"language":21,"meta":22,"style":22},"type HyogenDiagnostic = {\n  code: string\n  message: string\n  path?: string\n  details?: Record\u003Cstring, unknown>\n}\n\ntype HyogenWarning = HyogenDiagnostic\ntype HyogenError = Error & HyogenDiagnostic\n",[24,595,596,607,616,625,634,653,657,661,672],{"__ignoreMap":22},[27,597,598,600,603,605],{"class":29,"line":30},[27,599,129],{"class":33},[27,601,602],{"class":132}," HyogenDiagnostic",[27,604,136],{"class":33},[27,606,41],{"class":40},[27,608,609,612,614],{"class":29,"line":44},[27,610,611],{"class":191},"  code",[27,613,389],{"class":33},[27,615,234],{"class":145},[27,617,618,621,623],{"class":29,"line":50},[27,619,620],{"class":191},"  message",[27,622,389],{"class":33},[27,624,234],{"class":145},[27,626,627,630,632],{"class":29,"line":56},[27,628,629],{"class":191},"  path",[27,631,195],{"class":33},[27,633,234],{"class":145},[27,635,636,639,641,643,645,647,649,651],{"class":29,"line":62},[27,637,638],{"class":191},"  details",[27,640,195],{"class":33},[27,642,139],{"class":132},[27,644,142],{"class":40},[27,646,146],{"class":145},[27,648,149],{"class":40},[27,650,152],{"class":145},[27,652,155],{"class":40},[27,654,655],{"class":29,"line":68},[27,656,239],{"class":40},[27,658,659],{"class":29,"line":74},[27,660,491],{"emptyLinePlaceholder":490},[27,662,663,665,667,669],{"class":29,"line":80},[27,664,129],{"class":33},[27,666,479],{"class":132},[27,668,136],{"class":33},[27,670,671],{"class":132}," HyogenDiagnostic\n",[27,673,674,676,679,681,684,686],{"class":29,"line":86},[27,675,129],{"class":33},[27,677,678],{"class":132}," HyogenError",[27,680,136],{"class":33},[27,682,683],{"class":132}," Error",[27,685,328],{"class":33},[27,687,671],{"class":132},[116,689,690],{"id":690},"デフォルト値まとめ",[241,692,693,703],{},[244,694,695],{},[247,696,697,700],{},[250,698,699],{},"項目",[250,701,702],{},"デフォルト",[257,704,705,713,720,728],{},[247,706,707,710],{},[262,708,709],{},"front matter を出力に残す",[262,711,712],{},"OFF",[247,714,715,718],{},[262,716,717],{},"hyogen コメントを出力に残す",[262,719,712],{},[247,721,722,725],{},[262,723,724],{},"Node でのリモート include \u002F component",[262,726,727],{},"許可",[247,729,730,733],{},[262,731,732],{},"front matter ソースの上限",[262,734,735],{},"64 KB",[116,737,738],{"id":738},"関連",[740,741,742,749,754],"ul",{},[743,744,745],"li",{},[746,747,349],"a",{"href":748},"\u002Fja\u002Fapi\u002Frender-server",[743,750,751],{},[746,752,353],{"href":753},"\u002Fja\u002Fapi\u002Fbuild",[743,755,756],{},[746,757,759],{"href":758},"\u002Fja\u002Fapi\u002Ferror-codes","エラーコード",[761,762,763],"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 .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 .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}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}",{"title":22,"searchDepth":44,"depth":44,"links":765},[766,767,768,769,770,771,772,773,774],{"id":118,"depth":44,"text":119},{"id":169,"depth":44,"text":170},{"id":308,"depth":44,"text":309},{"id":360,"depth":44,"text":361},{"id":443,"depth":44,"text":444},{"id":289,"depth":44,"text":549},{"id":590,"depth":44,"text":590},{"id":690,"depth":44,"text":690},{"id":738,"depth":44,"text":738},"公開型・オプションの要約","md",{},"\u002Fapi\u002Ftypes-and-options",{"title":5,"description":775},"api\u002Ftypes-and-options","zv_meCi-eRp8kR91OMQd-TS-SASqRYE1hQr80eoGHhc",1787223114714]