1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[3207],{69195:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>r,metadata:()=>t,toc:()=>h});const t=JSON.parse('{"id":"getting-started","title":"Getting Started","description":"This guide provides an overview on the documentation structure and how to get started with the Phoenix Code API documentation!","source":"@site/api/01-getting-started.md","sourceDirName":".","slug":"/getting-started","permalink":"/api/getting-started","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":1,"frontMatter":{"title":"Getting Started"},"sidebar":"tutorialSidebar","next":{"title":"Creating Themes","permalink":"/api/creating-themes"}}');var s=i(74848),o=i(28453);const r={title:"Getting Started"},a=void 0,d={},h=[{value:"Documentation Structure",id:"documentation-structure",level:2},{value:"Creating Themes",id:"creating-themes",level:3},{value:"Creating Extensions",id:"creating-extensions",level:3},{value:"Use Node.js from extension",id:"use-nodejs-from-extension",level:3},{value:"Debugging Extensions",id:"debugging-extensions",level:3},{value:"Publishing Themes & Extensions",id:"publishing-themes--extensions",level:3},{value:"Available Standard Libraries",id:"available-standard-libraries",level:3},{value:"API Reference",id:"api-reference",level:2}];function c(e){const n={a:"a",blockquote:"blockquote",h2:"h2",h3:"h3",p:"p",strong:"strong",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"This guide provides an overview on the documentation structure and how to get started with the Phoenix Code API documentation!"}),"\n",(0,s.jsx)(n.h2,{id:"documentation-structure",children:"Documentation Structure"}),"\n",(0,s.jsx)(n.p,{children:"The Phoenix Code API documentation is organized into sections for easy navigation. Here\u2019s a quick overview of the key sections:"}),"\n",(0,s.jsx)(n.h3,{id:"creating-themes",children:(0,s.jsx)(n.a,{href:"./creating-themes",children:"Creating Themes"})}),"\n",(0,s.jsxs)(n.p,{children:["This page provides guidelines on how to create custom Themes for ",(0,s.jsx)(n.strong,{children:"Phoenix Code"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"creating-extensions",children:(0,s.jsx)(n.a,{href:"./creating-extensions",children:"Creating Extensions"})}),"\n",(0,s.jsxs)(n.p,{children:["This page provides guidelines on how to write Extensions for ",(0,s.jsx)(n.strong,{children:"Phoenix Code"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"use-nodejs-from-extension",children:(0,s.jsx)(n.a,{href:"./creating-node-extensions",children:"Use Node.js from extension"})}),"\n",(0,s.jsxs)(n.p,{children:["This page explains how to use Node.js inside ",(0,s.jsx)(n.strong,{children:"Phoenix Code"})," extensions."]}),"\n",(0,s.jsx)(n.h3,{id:"debugging-extensions",children:(0,s.jsx)(n.a,{href:"./debugging-extensions",children:"Debugging Extensions"})}),"\n",(0,s.jsxs)(n.p,{children:["This page provides a detailed guide on efficiently debugging your ",(0,s.jsx)(n.strong,{children:"Phoenix Code"})," extensions."]}),"\n",(0,s.jsx)(n.h3,{id:"publishing-themes--extensions",children:(0,s.jsx)(n.a,{href:"./publishing-extensions",children:"Publishing Themes & Extensions"})}),"\n",(0,s.jsxs)(n.p,{children:["This page provides guidelines on how to publish Themes/Extensions to ",(0,s.jsx)(n.strong,{children:"Phoenix Code"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"available-standard-libraries",children:(0,s.jsx)(n.a,{href:"./available-standard-libs",children:"Available Standard Libraries"})}),"\n",(0,s.jsxs)(n.p,{children:["This page lists all the standard libraries that are available for use inside ",(0,s.jsx)(n.strong,{children:"Phoenix Code"}),"."]}),"\n",(0,s.jsx)(n.h2,{id:"api-reference",children:"API Reference"}),"\n",(0,s.jsx)(n.p,{children:"The API-Reference directory contains detailed reference documentation for each part of the Phoenix Code API. Each page here corresponds to different components, functions, or modules of the API, providing explanations, usage examples, and detailed parameter descriptions."}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:["This documentation is automatically generated from the source code. To learn more about how these docs are generated, refer to ",(0,s.jsx)(n.a,{href:"https://github.com/phcode-dev/phoenix/wiki/02-Writing-Docs",children:"this link"}),"."]}),"\n"]})]})}function l(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(c,{...e})}):c(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>r,x:()=>a});var t=i(96540);const s={},o=t.createContext(s);function r(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.