[{"data":1,"prerenderedAt":293},["ShallowReactive",2],{"page:\u002Fdocs\u002F5.x\u002Freference\u002Fkit\u002Fextension-docs":3},{"id":4,"title":5,"body":6,"description":275,"extension":276,"frontmatter":277,"heading":5,"meta":284,"navigation":286,"order":281,"path":287,"seo":288,"sitemap":289,"source":290,"stem":291,"__hash__":292},"docs\u002Fdocs\u002F5.x\u002Freference\u002Fkit\u002Fextension-docs.md","Extension docs",{"type":7,"value":8,"toc":265},"minimark",[9,46,50,117,123,127,134,138,149,153,164,211,218,222,228,243,246],[10,11,12,13,17,18,25,26,30,31,34,35,38,39,38,42,45],"p",{},"An extension ships its docs in a ",[14,15,16],"code",{},"docs\u002F"," folder at the package root, next to ",[19,20,22],"a",{"href":21},".\u002Fmanifest",[14,23,24],{},"kubb-extension.json",". The ",[19,27,29],{"href":28},"\u002Fdocs\u002F5.x\u002Freference\u002Fregistry#detail","registry"," reads the folder from the npm tarball of the pinned version, and kubb.dev renders it under ",[14,32,33],{},"\u002Fextensions\u002F\u003Cowner>\u002F\u003Cslug>",". List ",[14,36,37],{},"docs"," in ",[14,40,41],{},"files",[14,43,44],{},"package.json"," so npm ships it.",[47,48,49],"h2",{"id":41},"Files",[51,52,53,69],"table",{},[54,55,56],"thead",{},[57,58,59,63,66],"tr",{},[60,61,62],"th",{},"File",[60,64,65],{},"Page on kubb.dev",[60,67,68],{},"Required",[70,71,72,88,103],"tbody",{},[57,73,74,80,85],{},[75,76,77],"td",{},[14,78,79],{},"docs\u002Foverview.md",[75,81,82,84],{},[14,83,33],{},", also the summary in Studio",[75,86,87],{},"Yes",[57,89,90,95,100],{},[75,91,92],{},[14,93,94],{},"docs\u002Foptions.md",[75,96,97],{},[14,98,99],{},"\u002Fextensions\u002F\u003Cowner>\u002F\u003Cslug>\u002Foptions",[75,101,102],{},"No",[57,104,105,110,115],{},[75,106,107],{},[14,108,109],{},"docs\u002Fguides\u002F\u003Cid>.md",[75,111,112],{},[14,113,114],{},"\u002Fextensions\u002F\u003Cowner>\u002F\u003Cslug>\u002Fguides\u002F\u003Cid>",[75,116,102],{},[10,118,119,120,122],{},"The registry ignores other files in ",[14,121,16],{},". It skips a file larger than 256 KiB and reports it.",[47,124,126],{"id":125},"title-and-description","Title and description",[10,128,129,130,133],{},"Start each file with a ",[14,131,132],{},"#"," title on its first line. The first paragraph after the title is the description, which guide cards, search, and the meta description show. Files have no frontmatter.",[47,135,137],{"id":136},"guides","Guides",[10,139,140,141,144,145,148],{},"Name each guide file in kebab case, such as ",[14,142,143],{},"base-url.md",". Its id is the file name without ",[14,146,147],{},".md",". Guides appear in file name order, at most 50. A guide without a title, a description, or a kebab-case id is not listed.",[47,150,152],{"id":151},"markdown","Markdown",[10,154,155,156,159,160,163],{},"Write plain Markdown, and use absolute ",[14,157,158],{},"https:\u002F\u002F"," URLs for links and images. A code fence can carry a title, such as ",[14,161,162],{},"```typescript [kubb.config.ts]",". These also render:",[165,166,167,186],"ul",{},[168,169,170,171,174,175,174,178,181,182,185],"li",{},"The callouts ",[14,172,173],{},"> [!NOTE]",", ",[14,176,177],{},"> [!TIP]",[14,179,180],{},"> [!IMPORTANT]",", and ",[14,183,184],{},"> [!WARNING]",".",[168,187,188,189,174,192,195,196,174,199,174,202,181,205,195,208,185],{},"The components ",[14,190,191],{},"::code-group",[14,193,194],{},"::field-group"," with ",[14,197,198],{},":::field",[14,200,201],{},"::steps",[14,203,204],{},"::code-collapse",[14,206,207],{},"::tabs",[14,209,210],{},":::tabs-item",[10,212,213,214,217],{},"kubb.dev does not render raw HTML, ",[14,215,216],{},"\u003C!--@include-->"," lines, twoslash code fences, or other components. Validation reports each one before a version is approved.",[47,219,221],{"id":220},"overview","Overview",[10,223,224,227],{},[14,225,226],{},"overview.md"," is the extension's page on kubb.dev. Cover these points in order, and add headings only when they help:",[229,230,231,234,237,240],"ol",{},[168,232,233],{},"What the extension is and does, in one or two short paragraphs.",[168,235,236],{},"How it works, only when that is not obvious.",[168,238,239],{},"The setup it needs, such as other plugins or peer packages.",[168,241,242],{},"Options worth explaining and known limits.",[10,244,245],{},"When the package runs an install script, uses the network, or touches files outside its output path, say so in the overview.",[10,247,248,249,174,252,174,255,174,258,261,262,185],{},"Use sentence case, plain language, and no em dashes. Leave out install commands, badges, a changelog, license text, and marketing. The page already shows how to install, and validation fails for an overview that contains ",[14,250,251],{},"kubb add",[14,253,254],{},"npm install",[14,256,257],{},"npm i",[14,259,260],{},"pnpm add",", or ",[14,263,264],{},"yarn add",{"title":266,"searchDepth":267,"depth":267,"links":268},"",5,[269,271,272,273,274],{"id":41,"depth":270,"text":49},2,{"id":125,"depth":270,"text":126},{"id":136,"depth":270,"text":137},{"id":151,"depth":270,"text":152},{"id":220,"depth":270,"text":221},"Reference for the docs folder a Kubb plugin, adapter, or parser ships on npm. Covers the files kubb.dev renders, titles and descriptions, guide ids, and the Markdown that renders.","md",{"layout":278,"title":5,"description":275,"outline":279,"order":281,"navigation":282},"doc",[270,280],3,16,{"title":5,"icon":283},"i-iconoir-book",{"layout":278,"outline":285},[270,280],{"title":5,"icon":283},"\u002Fdocs\u002F5.x\u002Freference\u002Fkit\u002Fextension-docs",{"title":5,"description":275},{"loc":287},"kubb-labs\u002Fkubb\u002Fdocs\u002F5.x\u002Freference\u002Fkit\u002Fextension-docs.md","docs\u002F5.x\u002Freference\u002Fkit\u002Fextension-docs","kdQ_e4Df-6f96yp6jX-pZDUTM01l3dhcRvt2ibC4q6M",1793639043037]