1"use strict";(self.webpackChunkwoodpecker=self.webpackChunkwoodpecker||[]).push([["4107"],{80564(e,t,n){n.r(t),n.d(t,{metadata:()=>o,default:()=>u,frontMatter:()=>d,contentTitle:()=>i,toc:()=>c,assets:()=>a});var o=JSON.parse('{"id":"development/docs","title":"Documentation","description":"The documentation is using docusaurus as framework. You can learn more about it from its official documentation.","source":"@site/versioned_docs/version-3.16/92-development/04-docs.md","sourceDirName":"92-development","slug":"/development/docs","permalink":"/docs/3.16/development/docs","draft":false,"unlisted":false,"editUrl":"https://github.com/woodpecker-ci/woodpecker/edit/main/docs/versioned_docs/version-3.16/92-development/04-docs.md","tags":[],"version":"3.16","sidebarPosition":4,"frontMatter":{},"sidebar":"tutorialSidebar","previous":{"title":"UI Development","permalink":"/docs/3.16/development/ui"},"next":{"title":"Architecture","permalink":"/docs/3.16/development/architecture"}}'),s=n(94686),r=n(23191);let d={},i="Documentation",a={},c=[];function l(e){let t={a:"a",code:"code",h1:"h1",header:"header",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.header,{children:(0,s.jsx)(t.h1,{id:"documentation",children:"Documentation"})}),"\n",(0,s.jsxs)(t.p,{children:["The documentation is using docusaurus as framework. You can learn more about it from its ",(0,s.jsx)(t.a,{href:"https://docusaurus.io/docs/",children:"official documentation"}),"."]}),"\n",(0,s.jsxs)(t.p,{children:["If you only want to change some text it probably is enough if you just search for the corresponding ",(0,s.jsx)(t.a,{href:"https://www.markdownguide.org/basic-syntax/",children:"Markdown"})," file inside the ",(0,s.jsx)(t.code,{children:"docs/docs/"})," folder and adjust it. If you want to change larger parts and test the rendered documentation you can run docusaurus locally. Similarly to the UI you need to install ",(0,s.jsx)(t.a,{href:"/docs/3.16/development/getting-started#install-nodejs--pnpm",children:"Node.js and pnpm"}),". After that you can run and build docusaurus locally by using the following commands:"]}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-bash",children:"cd docs/\n\npnpm install\n\n# build plugins used by the docs\npnpm build:woodpecker-plugins\n\n# start docs with hot-reloading, so you can change the docs and directly see the changes in the browser without reloading it manually\npnpm start\n\n# or build the docs to deploy it to some static page hosting\npnpm build\n"})})]})}function u(e={}){let{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},23191(e,t,n){n.d(t,{R:()=>d,x:()=>i});var o=n(92990);let s={},r=o.createContext(s);function d(e){let t=o.useContext(r);return o.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),o.createElement(r.Provider,{value:t},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.