[{"data":1,"prerenderedAt":357},["ShallowReactive",2],{"\u002Fdocs\u002Fcommunity\u002Fcontributing":3},{"id":4,"title":5,"body":6,"description":349,"extension":350,"meta":351,"navigation":352,"path":353,"seo":354,"stem":355,"__hash__":356},"docs\u002Fdocs\u002Fcommunity\u002Fcontributing.md","Contributing",{"type":7,"value":8,"toc":343},"minimark",[9,13,17,22,40,108,112,121,181,184,188,195,250,256,289,328,332,339],[10,11,5],"h1",{"id":12},"contributing",[14,15,16],"p",{},"LeiOS is open source, and contributions of every size are welcome: bug reports, documentation\nfixes, packages, and code.",[18,19,21],"h2",{"id":20},"repositories","Repositories",[14,23,24,25,33,34,39],{},"All LeiOS projects are developed on\n",[26,27,32],"a",{"href":28,"rel":29,"target":31},"https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS",[30],"nofollow","_blank","git.leicraftmc.de\u002FLeiOS"," and mirrored to\n",[26,35,38],{"href":36,"rel":37,"target":31},"https:\u002F\u002Fgithub.com\u002FLeiOS-project",[30],"GitHub",".",[41,42,43,56],"table",{},[44,45,46],"thead",{},[47,48,49,53],"tr",{},[50,51,52],"th",{},"Repository",[50,54,55],{},"What it is",[57,58,59,72,84,96],"tbody",{},[47,60,61,69],{},[62,63,64],"td",{},[26,65,68],{"href":66,"rel":67,"target":31},"https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS\u002Flive-images",[30],"live-images",[62,70,71],{},"The live-build configuration for the LeiOS ISO and installer.",[47,73,74,81],{},[62,75,76],{},[26,77,80],{"href":78,"rel":79,"target":31},"https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS\u002Frepo\u002Fapi-server",[30],"repo\u002Fapi-server",[62,82,83],{},"The Repository API: package uploads, checks, and publishing.",[47,85,86,93],{},[62,87,88],{},[26,89,92],{"href":90,"rel":91,"target":31},"https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS\u002FHub-Website",[30],"Hub-Website",[62,94,95],{},"The Developer Hub at hub.leios.dev.",[47,97,98,105],{},[62,99,100],{},[26,101,104],{"href":102,"rel":103,"target":31},"https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS\u002Fwebsite",[30],"website",[62,106,107],{},"This website and its documentation.",[18,109,111],{"id":110},"conventions","Conventions",[14,113,114,115,120],{},"LeiOS follows the ",[26,116,119],{"href":117,"rel":118,"target":31},"https:\u002F\u002Fgit.leicraftmc.de\u002FLeiCraftMC\u002FStyle-Guides",[30],"LeiCraftMC Style Guides",":",[122,123,124,132,141,155,175],"ul",{},[125,126,127,131],"li",{},[128,129,130],"strong",{},"Bun"," as runtime, package manager and test runner.",[125,133,134,137,138,39],{},[128,135,136],{},"TypeScript"," everywhere, formatted and linted with ",[128,139,140],{},"Biome",[125,142,143,146,147,150,151,154],{},[128,144,145],{},"Nuxt 4",", ",[128,148,149],{},"Nuxt UI"," and ",[128,152,153],{},"Tailwind CSS"," for the web projects.",[125,156,157,160,161,146,165,146,168,146,171,174],{},[128,158,159],{},"Conventional Commits"," for commit messages: ",[162,163,164],"code",{},"feat:",[162,166,167],{},"fix:",[162,169,170],{},"docs:",[162,172,173],{},"chore:",", and so on.",[125,176,177,180],{},[128,178,179],{},"AGPL-3.0"," as the license.",[14,182,183],{},"Read the style guide before your first larger contribution. Small fixes are welcome any time.",[18,185,187],{"id":186},"improving-these-docs","Improving these docs",[14,189,190,191,194],{},"Every docs page has an ",[128,192,193],{},"Edit this page"," link at the bottom that opens the page's source on\ngit.leicraftmc.de. To work on the docs locally:",[196,197,202],"pre",{"className":198,"code":199,"language":200,"meta":201,"style":201},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","git clone https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS\u002Fwebsite.git\ncd website\nbun install\nbun run dev\n","bash","",[162,203,204,220,230,239],{"__ignoreMap":201},[205,206,209,213,217],"span",{"class":207,"line":208},"line",1,[205,210,212],{"class":211},"sBMFI","git",[205,214,216],{"class":215},"sfazB"," clone",[205,218,219],{"class":215}," https:\u002F\u002Fgit.leicraftmc.de\u002FLeiOS\u002Fwebsite.git\n",[205,221,223,227],{"class":207,"line":222},2,[205,224,226],{"class":225},"s2Zo4","cd",[205,228,229],{"class":215}," website\n",[205,231,233,236],{"class":207,"line":232},3,[205,234,235],{"class":211},"bun",[205,237,238],{"class":215}," install\n",[205,240,242,244,247],{"class":207,"line":241},4,[205,243,235],{"class":211},[205,245,246],{"class":215}," run",[205,248,249],{"class":215}," dev\n",[14,251,252,253,39],{},"The dev server runs on ",[162,254,255],{},"http:\u002F\u002Flocalhost:12155",[122,257,258,276,286],{},[125,259,260,261,264,265,146,268,271,272,275],{},"Pages are Markdown files in ",[162,262,263],{},"content\u002Fdocs\u002F",". Each needs ",[162,266,267],{},"title",[162,269,270],{},"description"," and\n",[162,273,274],{},"navigation.title"," frontmatter.",[125,277,278,279,282,283,39],{},"The sidebar and the previous\u002Fnext links come from ",[162,280,281],{},"app\u002Fdata\u002Fdocs.ts",". Add new pages there, and to\n",[162,284,285],{},"public\u002Fstatic\u002Futils\u002Fsitemap.xml",[125,287,288],{},"Before you open a merge request, run the checks:",[196,290,292],{"className":198,"code":291,"language":200,"meta":201,"style":201},"bun run check\nbun run typecheck\nbun test\nbun run generate\n",[162,293,294,303,312,319],{"__ignoreMap":201},[205,295,296,298,300],{"class":207,"line":208},[205,297,235],{"class":211},[205,299,246],{"class":215},[205,301,302],{"class":215}," check\n",[205,304,305,307,309],{"class":207,"line":222},[205,306,235],{"class":211},[205,308,246],{"class":215},[205,310,311],{"class":215}," typecheck\n",[205,313,314,316],{"class":207,"line":232},[205,315,235],{"class":211},[205,317,318],{"class":215}," test\n",[205,320,321,323,325],{"class":207,"line":241},[205,322,235],{"class":211},[205,324,246],{"class":215},[205,326,327],{"class":215}," generate\n",[18,329,331],{"id":330},"publishing-packages","Publishing packages",[14,333,334,335,39],{},"Want to ship software to LeiOS users? See ",[26,336,338],{"href":337},"\u002Fdocs\u002Fdevelopers\u002Fpublishing-packages","Publishing Packages",[340,341,342],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}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);}",{"title":201,"searchDepth":222,"depth":222,"links":344},[345,346,347,348],{"id":20,"depth":222,"text":21},{"id":110,"depth":222,"text":111},{"id":186,"depth":222,"text":187},{"id":330,"depth":222,"text":331},"The LeiOS repositories, the conventions they follow, and how to improve these docs.","md",{},{"title":5},"\u002Fdocs\u002Fcommunity\u002Fcontributing",{"title":5,"description":349},"docs\u002Fcommunity\u002Fcontributing","4P3d0mEJRV2IhMtxL7M7C8NFxmd3nyPSr_YTsQhcQiQ",1792353300465]