https://docs.nbagent.ai/static/js/async/6665.94bdd3f2e9.js

1"use strict";(self.rspackChunknebulaAiDocs=self.rspackChunknebulaAiDocs||[]).push([["6665"],{1552(e,r,s){s.r(r),s.d(r,{default:()=>c});var n=s(2615),i=s(416),t=s(6495);function d(e){let r={a:"a",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",span:"span",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(r.h1,{id:"getting-started",children:[(0,n.jsx)(r.a,{className:"rp-header-anchor","aria-hidden":"true",href:"#getting-started",children:"#"}),"Getting started"]}),"\n",(0,n.jsxs)(r.h2,{id:"project-structure",children:[(0,n.jsx)(r.a,{className:"rp-header-anchor","aria-hidden":"true",href:"#project-structure",children:"#"}),"Project structure"]}),"\n",(0,n.jsxs)(r.p,{children:["After creating a project with ",(0,n.jsx)(r.code,{children:"create-rspress"}),", you will get the following project structure:"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"docs/"})," — The documentation source directory, configured via ",(0,n.jsx)(r.code,{children:"root"})," in ",(0,n.jsx)(r.code,{children:"rspress.config.ts"}),"."]}),"\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"docs/_nav.json"})," — The navigation bar configuration."]}),"\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"docs/guide/_meta.json"})," — The sidebar configuration for the guide section."]}),"\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"docs/public/"})," — Static assets directory."]}),"\n",(0,n.jsxs)(r.li,{children:[(0,n.jsx)(r.code,{children:"rspress.config.ts"})," — The Rspress configuration file."]}),"\n"]}),"\n",(0,n.jsxs)(r.h2,{id:"development",children:[(0,n.jsx)(r.a,{className:"rp-header-anchor","aria-hidden":"true",href:"#development",children:"#"}),"Development"]}),"\n",(0,n.jsx)(r.p,{children:"Start the local development server:"}),"\n",(0,n.jsx)(n.Fragment,{children:(0,n.jsx)(r.pre,{className:"shiki css-variables",style:{backgroundColor:"var(--shiki-background)",color:"var(--shiki-foreground)"},tabIndex:"0",lang:"bash",children:(0,n.jsx)(r.code,{children:(0,n.jsxs)(r.span,{className:"line",children:[(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-function)"},children:"npm"}),(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-string)"},children:" run"}),(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-string)"},children:" dev"})]})})})}),"\n",(0,n.jsx)(t.P,{type:"tip",title:"Tip",children:(0,n.jsxs)(r.p,{children:["You can specify the port number or host with ",(0,n.jsx)(r.code,{children:"--port"})," or ",(0,n.jsx)(r.code,{children:"--host"}),", such as ",(0,n.jsx)(r.code,{children:"rspress dev --port 8080 --host 0.0.0.0"}),"."]})}),"\n",(0,n.jsxs)(r.h2,{id:"production-build",children:[(0,n.jsx)(r.a,{className:"rp-header-anchor","aria-hidden":"true",href:"#production-build",children:"#"}),"Production build"]}),"\n",(0,n.jsx)(r.p,{children:"Build the site for production:"}),"\n",(0,n.jsx)(n.Fragment,{children:(0,n.jsx)(r.pre,{className:"shiki css-variables",style:{backgroundColor:"var(--shiki-background)",color:"var(--shiki-foreground)"},tabIndex:"0",lang:"bash",children:(0,n.jsx)(r.code,{children:(0,n.jsxs)(r.span,{className:"line",children:[(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-function)"},children:"npm"}),(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-string)"},children:" run"}),(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-string)"},children:" build"})]})})})}),"\n",(0,n.jsxs)(r.p,{children:["By default, Rspress will output to ",(0,n.jsx)(r.code,{children:"doc_build"})," directory."]}),"\n",(0,n.jsxs)(r.h2,{id:"preview",children:[(0,n.jsx)(r.a,{className:"rp-header-anchor","aria-hidden":"true",href:"#preview",children:"#"}),"Preview"]}),"\n",(0,n.jsx)(r.p,{children:"Preview the production build locally:"}),"\n",(0,n.jsx)(n.Fragment,{children:(0,n.jsx)(r.pre,{className:"shiki css-variables",style:{backgroundColor:"var(--shiki-background)",color:"var(--shiki-foreground)"},tabIndex:"0",lang:"bash",children:(0,n.jsx)(r.code,{children:(0,n.jsxs)(r.span,{className:"line",children:[(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-function)"},children:"npm"}),(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-string)"},children:" run"}),(0,n.jsx)(r.span,{style:{color:"var(--shiki-token-string)"},children:" preview"})]})})})}),"\n",(0,n.jsxs)(r.h2,{id:"next-steps",children:[(0,n.jsx)(r.a,{className:"rp-header-anchor","aria-hidden":"true",href:"#next-steps",children:"#"}),"Next steps"]}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsxs)(r.li,{children:["Learn how to use ",(0,n.jsx)(r.a,{href:"/guide/use-mdx/components.html",children:"MDX & React Components"})," in your docs."]}),"\n",(0,n.jsxs)(r.li,{children:["Learn about ",(0,n.jsx)(r.a,{href:"/guide/use-mdx/code-blocks/index.html",children:"Code Blocks"})," syntax highlighting and line highlighting."]}),"\n",(0,n.jsxs)(r.li,{children:["Learn about ",(0,n.jsx)(r.a,{href:"/guide/use-mdx/container.html",children:"Custom Containers"})," for tips, warnings, and more."]}),"\n",(0,n.jsxs)(r.li,{children:["Explore the full ",(0,n.jsx)(r.a,{href:"https://rspress.rs/",rel:"noopener noreferrer",target:"_blank",children:"Rspress documentation"})," for advanced features."]}),"\n"]})]})}function c(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(d,{...e})}):d(e)}c.__RSPRESS_PAGE_META={},c.__RSPRESS_PAGE_META["guide%2Fstart%2Fgetting-started.md"]={toc:[{id:"project-structure",text:"Project structure",depth:2},{id:"development",text:"Development",depth:2},{id:"production-build",text:"Production build",depth:2},{id:"preview",text:"Preview",depth:2},{id:"next-steps",text:"Next steps",depth:2}],title:"Getting started",headingTitle:"Getting started",frontmatter:{}}}}]);