This commit is contained in:
chenasraf
2024-03-24 11:41:46 +00:00
parent 6cad38adcf
commit 38d1bb31b8
38 changed files with 267 additions and 267 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[85],{3678:(e,a,s)=>{s.r(a),s.d(a,{default:()=>x});s(959);var c=s(6259),l=s(9138),i=s(9065),n=s(5298),r=s(9488),t=s(1479),d=s(8281);const o={mdxPageWrapper:"mdxPageWrapper_tS8w"};var m=s(1527);function x(e){const{content:a}=e,{metadata:{title:s,description:x,frontMatter:p,unlisted:g},assets:h}=a,{keywords:_,wrapperClassName:j,hide_table_of_contents:f}=p,v=h.image??p.image;return(0,m.jsx)(l.FG,{className:(0,c.Z)(j??i.k.wrapper.mdxPages,i.k.page.mdxPage),children:(0,m.jsxs)(n.Z,{children:[(0,m.jsx)(l.d,{title:s,description:x,keywords:_,image:v}),(0,m.jsx)("main",{className:"container container--fluid margin-vert--lg",children:(0,m.jsxs)("div",{className:(0,c.Z)("row",o.mdxPageWrapper),children:[(0,m.jsxs)("div",{className:(0,c.Z)("col",!f&&"col--8"),children:[g&&(0,m.jsx)(d.Z,{}),(0,m.jsx)("article",{children:(0,m.jsx)(r.Z,{children:(0,m.jsx)(a,{})})})]}),!f&&a.toc.length>0&&(0,m.jsx)("div",{className:"col col--2",children:(0,m.jsx)(t.Z,{toc:a.toc,minHeadingLevel:p.toc_min_heading_level,maxHeadingLevel:p.toc_max_heading_level})})]})})]})})}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[85],{6119:(e,a,s)=>{s.r(a),s.d(a,{default:()=>x});s(959);var c=s(6259),l=s(9138),i=s(9065),n=s(6923),r=s(3642),d=s(5229),t=s(7846);const o={mdxPageWrapper:"mdxPageWrapper_Fy2D"};var m=s(1527);function x(e){const{content:a}=e,{metadata:{title:s,description:x,frontMatter:p,unlisted:g},assets:h}=a,{keywords:_,wrapperClassName:j,hide_table_of_contents:f}=p,v=h.image??p.image;return(0,m.jsx)(l.FG,{className:(0,c.Z)(j??i.k.wrapper.mdxPages,i.k.page.mdxPage),children:(0,m.jsxs)(n.Z,{children:[(0,m.jsx)(l.d,{title:s,description:x,keywords:_,image:v}),(0,m.jsx)("main",{className:"container container--fluid margin-vert--lg",children:(0,m.jsxs)("div",{className:(0,c.Z)("row",o.mdxPageWrapper),children:[(0,m.jsxs)("div",{className:(0,c.Z)("col",!f&&"col--8"),children:[g&&(0,m.jsx)(t.Z,{}),(0,m.jsx)("article",{children:(0,m.jsx)(r.Z,{children:(0,m.jsx)(a,{})})})]}),!f&&a.toc.length>0&&(0,m.jsx)("div",{className:"col col--2",children:(0,m.jsx)(d.Z,{toc:a.toc,minHeadingLevel:p.toc_min_heading_level,maxHeadingLevel:p.toc_max_heading_level})})]})})]})})}}}]);

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[463],{8741:(e,t,s)=>{s.d(t,{Z:()=>l});s(959);var i=s(6259),n=s(4547),o=s(2371),a=s(1527);function l(e){let{className:t}=e;return(0,a.jsx)("main",{className:(0,i.Z)("container margin-vert--xl",t),children:(0,a.jsx)("div",{className:"row",children:(0,a.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,a.jsx)(o.Z,{as:"h1",className:"hero__title",children:(0,a.jsx)(n.Z,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,a.jsx)("p",{children:(0,a.jsx)(n.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,a.jsx)("p",{children:(0,a.jsx)(n.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},3463:(e,t,s)=>{s.r(t),s.d(t,{default:()=>d});s(959);var i=s(4547),n=s(9138),o=s(5298),a=s(8741),l=s(1527);function d(){const e=(0,i.I)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.d,{title:e}),(0,l.jsx)(o.Z,{children:(0,l.jsx)(a.Z,{})})]})}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[338],{8300:(e,t,s)=>{s.d(t,{Z:()=>l});s(959);var i=s(6259),n=s(4547),o=s(4361),a=s(1527);function l(e){let{className:t}=e;return(0,a.jsx)("main",{className:(0,i.Z)("container margin-vert--xl",t),children:(0,a.jsx)("div",{className:"row",children:(0,a.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,a.jsx)(o.Z,{as:"h1",className:"hero__title",children:(0,a.jsx)(n.Z,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,a.jsx)("p",{children:(0,a.jsx)(n.Z,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,a.jsx)("p",{children:(0,a.jsx)(n.Z,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}},5338:(e,t,s)=>{s.r(t),s.d(t,{default:()=>d});s(959);var i=s(4547),n=s(9138),o=s(6923),a=s(8300),l=s(1527);function d(){const e=(0,i.I)({id:"theme.NotFound.title",message:"Page Not Found"});return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.d,{title:e}),(0,l.jsx)(o.Z,{children:(0,l.jsx)(a.Z,{})})]})}}}]);

File diff suppressed because one or more lines are too long

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[902],{4330:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>r,contentTitle:()=>l,default:()=>f,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var t=n(1527),i=n(8672);const a={title:"Usage"},l=void 0,o={id:"usage/index",title:"Usage",description:"- CLI Usage",source:"@site/docs/usage/index.md",sourceDirName:"usage",slug:"/usage/",permalink:"/simple-scaffold/docs/usage/",draft:!1,unlisted:!1,editUrl:"https://github.com/chenasraf/simple-scaffold/blob/master/docs/docs/usage/index.md",tags:[],version:"current",frontMatter:{title:"Usage"},sidebar:"docs",previous:{title:"ScaffoldConfig",permalink:"/simple-scaffold/docs/api/interfaces/ScaffoldConfig"},next:{title:"Template Files",permalink:"/simple-scaffold/docs/usage/templates"}},r={},c=[];function d(e){const s={a:"a",li:"li",ul:"ul",...(0,i.a)(),...e.components};return(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"cli",children:"CLI Usage"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"configuration_files",children:"Configuration Files"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"examples",children:"Examples"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"migration",children:"Migration"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"node",children:"Node.js Usage"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"templates",children:"Template Files"})}),"\n"]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},8672:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>l});var t=n(959);const i={},a=t.createContext(i);function l(e){const s=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(a.Provider,{value:s},e.children)}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[902],{4330:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>r,contentTitle:()=>l,default:()=>f,frontMatter:()=>a,metadata:()=>o,toc:()=>c});var t=n(1527),i=n(3108);const a={title:"Usage"},l=void 0,o={id:"usage/index",title:"Usage",description:"- CLI Usage",source:"@site/docs/usage/index.md",sourceDirName:"usage",slug:"/usage/",permalink:"/simple-scaffold/docs/usage/",draft:!1,unlisted:!1,editUrl:"https://github.com/chenasraf/simple-scaffold/blob/master/docs/docs/usage/index.md",tags:[],version:"current",frontMatter:{title:"Usage"},sidebar:"docs",previous:{title:"ScaffoldConfig",permalink:"/simple-scaffold/docs/api/interfaces/ScaffoldConfig"},next:{title:"Template Files",permalink:"/simple-scaffold/docs/usage/templates"}},r={},c=[];function d(e){const s={a:"a",li:"li",ul:"ul",...(0,i.a)(),...e.components};return(0,t.jsxs)(s.ul,{children:["\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"cli",children:"CLI Usage"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"configuration_files",children:"Configuration Files"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"examples",children:"Examples"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"migration",children:"Migration"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"node",children:"Node.js Usage"})}),"\n",(0,t.jsx)(s.li,{children:(0,t.jsx)(s.a,{href:"templates",children:"Template Files"})}),"\n"]})}function f(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},3108:(e,s,n)=>{n.d(s,{Z:()=>o,a:()=>l});var t=n(959);const i={},a=t.createContext(i);function l(e){const s=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(a.Provider,{value:s},e.children)}}}]);

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[414],{7751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>i,frontMatter:()=>s,metadata:()=>p,toc:()=>d});var o=t(1527),a=t(8672);const s={title:"Markdown page example"},r="Markdown page example",p={type:"mdx",permalink:"/simple-scaffold/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"},unlisted:!1},c={},d=[];function l(e){const n={h1:"h1",p:"p",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"markdown-page-example",children:"Markdown page example"}),"\n",(0,o.jsx)(n.p,{children:"You don't need React to write simple standalone pages."})]})}function i(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},8672:(e,n,t)=>{t.d(n,{Z:()=>p,a:()=>r});var o=t(959);const a={},s=o.createContext(a);function r(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function p(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[414],{7751:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>i,frontMatter:()=>s,metadata:()=>p,toc:()=>d});var o=t(1527),a=t(3108);const s={title:"Markdown page example"},r="Markdown page example",p={type:"mdx",permalink:"/simple-scaffold/markdown-page",source:"@site/src/pages/markdown-page.md",title:"Markdown page example",description:"You don't need React to write simple standalone pages.",frontMatter:{title:"Markdown page example"},unlisted:!1},c={},d=[];function l(e){const n={h1:"h1",p:"p",...(0,a.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"markdown-page-example",children:"Markdown page example"}),"\n",(0,o.jsx)(n.p,{children:"You don't need React to write simple standalone pages."})]})}function i(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(l,{...e})}):l(e)}},3108:(e,n,t)=>{t.d(n,{Z:()=>p,a:()=>r});var o=t(959);const a={},s=o.createContext(a);function r(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function p(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:r(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]);

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[661],{9160:(s,e,c)=>{c.r(e),c.d(e,{default:()=>o});c(959);var r=c(6259),a=c(9138),l=c(9065),d=c(3797),u=c(5298),f=c(1527);function o(s){return(0,f.jsx)(a.FG,{className:(0,r.Z)(l.k.wrapper.docsPages),children:(0,f.jsx)(u.Z,{children:(0,d.H)(s.route.routes)})})}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[661],{2644:(s,e,c)=>{c.r(e),c.d(e,{default:()=>o});c(959);var r=c(6259),a=c(9138),l=c(9065),d=c(3797),u=c(6923),f=c(1527);function o(s){return(0,f.jsx)(a.FG,{className:(0,r.Z)(l.k.wrapper.docsPages),children:(0,f.jsx)(u.Z,{children:(0,d.H)(s.route.routes)})})}}}]);

File diff suppressed because one or more lines are too long

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[518],{1258:(s,n,e)=>{e.r(n),e.d(n,{default:()=>u});e(959);var o=e(9138),r=e(7787),c=e(4472),t=e(3797),i=e(6903),l=e(1527);function a(s){const{version:n}=s;return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(i.Z,{version:n.version,tag:(0,r.os)(n.pluginId,n.version)}),(0,l.jsx)(o.d,{children:n.noIndex&&(0,l.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function d(s){const{version:n,route:e}=s;return(0,l.jsx)(o.FG,{className:n.className,children:(0,l.jsx)(c.q,{version:n,children:(0,t.H)(e.routes)})})}function u(s){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(a,{...s}),(0,l.jsx)(d,{...s})]})}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[518],{8095:(s,n,e)=>{e.r(n),e.d(n,{default:()=>u});e(959);var o=e(9138),r=e(7787),c=e(4472),t=e(3797),i=e(2784),l=e(1527);function a(s){const{version:n}=s;return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(i.Z,{version:n.version,tag:(0,r.os)(n.pluginId,n.version)}),(0,l.jsx)(o.d,{children:n.noIndex&&(0,l.jsx)("meta",{name:"robots",content:"noindex, nofollow"})})]})}function d(s){const{version:n,route:e}=s;return(0,l.jsx)(o.FG,{className:n.className,children:(0,l.jsx)(c.q,{version:n,children:(0,t.H)(e.routes)})})}function u(s){return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(a,{...s}),(0,l.jsx)(d,{...s})]})}}}]);

File diff suppressed because one or more lines are too long

View File

@@ -1 +1 @@
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[300],{2516:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>f,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var o=t(1527),s=t(8672);const r={title:"Node.js Usage"},i=void 0,a={id:"usage/node",title:"Node.js Usage",description:"Overview",source:"@site/docs/usage/04-node.md",sourceDirName:"usage",slug:"/usage/node",permalink:"/simple-scaffold/docs/usage/node",draft:!1,unlisted:!1,editUrl:"https://github.com/chenasraf/simple-scaffold/blob/master/docs/docs/usage/04-node.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Node.js Usage"},sidebar:"docs",previous:{title:"CLI Usage",permalink:"/simple-scaffold/docs/usage/cli"},next:{title:"Examples",permalink:"/simple-scaffold/docs/usage/examples"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Before Write option",id:"before-write-option",level:3},{value:"Example",id:"example",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,o.jsx)(n.p,{children:"You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,\netc - simply pass a config object to the Scaffold function when you are ready to start."}),"\n",(0,o.jsxs)(n.p,{children:["The config takes similar arguments to the command line. The full type definitions can be found in\n",(0,o.jsx)(n.a,{href:"https://github.com/chenasraf/simple-scaffold/blob/develop/src/types.ts#L13",children:"src/types.ts"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See the full\n",(0,o.jsx)(n.a,{href:"https://chenasraf.github.io/simple-scaffold/interfaces/ScaffoldConfig.html",children:"documentation"})," for the\nconfiguration options and their behavior."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"interface ScaffoldConfig {\n name: string\n templates: string[]\n output: FileResponse<string>\n createSubFolder?: boolean\n data?: Record<string, any>\n overwrite?: FileResponse<boolean>\n quiet?: boolean\n verbose?: LogLevel\n dryRun?: boolean\n helpers?: Record<string, Helper>\n subFolderNameHelper?: DefaultHelpers | string\n beforeWrite?(\n content: Buffer,\n rawContent: Buffer,\n outputPath: string,\n ): string | Buffer | undefined | Promise<string | Buffer | undefined>\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"before-write-option",children:"Before Write option"}),"\n",(0,o.jsx)(n.p,{children:"This option allows you to preprocess a file before it is being written, such as running a formatter,\nlinter or other commands."}),"\n",(0,o.jsx)(n.p,{children:"To use this option, you can run any async/blocking command, and return a string as the final output\nto be used as the file contents."}),"\n",(0,o.jsxs)(n.p,{children:["Returning ",(0,o.jsx)(n.code,{children:"undefined"})," will keep the file contents as-is, after normal Handlebars.js procesing by\nSimple Scaffold."]}),"\n",(0,o.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,o.jsx)(n.p,{children:"This is an example of loading a complete scaffold via Node.js:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-typescript",children:'import Scaffold from "simple-scaffold"\n\nconst config = {\n name: "component",\n templates: [path.join(__dirname, "scaffolds", "component")],\n output: path.join(__dirname, "src", "components"),\n createSubFolder: true,\n subFolderNameHelper: "upperCase"\n data: {\n property: "value",\n },\n helpers: {\n twice: (text) => [text, text].join(" ")\n },\n // return a string to replace the final file contents after pre-processing, or `undefined`\n // to keep it as-is\n beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()\n}\n\nconst scaffold = Scaffold(config)\n'})})]})}function f(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},8672:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var o=t(959);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.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:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]);
"use strict";(self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[]).push([[300],{2516:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>f,frontMatter:()=>r,metadata:()=>a,toc:()=>c});var o=t(1527),s=t(3108);const r={title:"Node.js Usage"},i=void 0,a={id:"usage/node",title:"Node.js Usage",description:"Overview",source:"@site/docs/usage/04-node.md",sourceDirName:"usage",slug:"/usage/node",permalink:"/simple-scaffold/docs/usage/node",draft:!1,unlisted:!1,editUrl:"https://github.com/chenasraf/simple-scaffold/blob/master/docs/docs/usage/04-node.md",tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Node.js Usage"},sidebar:"docs",previous:{title:"CLI Usage",permalink:"/simple-scaffold/docs/usage/cli"},next:{title:"Examples",permalink:"/simple-scaffold/docs/usage/examples"}},l={},c=[{value:"Overview",id:"overview",level:2},{value:"Before Write option",id:"before-write-option",level:3},{value:"Example",id:"example",level:2}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,s.a)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h2,{id:"overview",children:"Overview"}),"\n",(0,o.jsx)(n.p,{children:"You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,\netc - simply pass a config object to the Scaffold function when you are ready to start."}),"\n",(0,o.jsxs)(n.p,{children:["The config takes similar arguments to the command line. The full type definitions can be found in\n",(0,o.jsx)(n.a,{href:"https://github.com/chenasraf/simple-scaffold/blob/develop/src/types.ts#L13",children:"src/types.ts"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See the full\n",(0,o.jsx)(n.a,{href:"https://chenasraf.github.io/simple-scaffold/interfaces/ScaffoldConfig.html",children:"documentation"})," for the\nconfiguration options and their behavior."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"interface ScaffoldConfig {\n name: string\n templates: string[]\n output: FileResponse<string>\n createSubFolder?: boolean\n data?: Record<string, any>\n overwrite?: FileResponse<boolean>\n quiet?: boolean\n verbose?: LogLevel\n dryRun?: boolean\n helpers?: Record<string, Helper>\n subFolderNameHelper?: DefaultHelpers | string\n beforeWrite?(\n content: Buffer,\n rawContent: Buffer,\n outputPath: string,\n ): string | Buffer | undefined | Promise<string | Buffer | undefined>\n}\n"})}),"\n",(0,o.jsx)(n.h3,{id:"before-write-option",children:"Before Write option"}),"\n",(0,o.jsx)(n.p,{children:"This option allows you to preprocess a file before it is being written, such as running a formatter,\nlinter or other commands."}),"\n",(0,o.jsx)(n.p,{children:"To use this option, you can run any async/blocking command, and return a string as the final output\nto be used as the file contents."}),"\n",(0,o.jsxs)(n.p,{children:["Returning ",(0,o.jsx)(n.code,{children:"undefined"})," will keep the file contents as-is, after normal Handlebars.js procesing by\nSimple Scaffold."]}),"\n",(0,o.jsx)(n.h2,{id:"example",children:"Example"}),"\n",(0,o.jsx)(n.p,{children:"This is an example of loading a complete scaffold via Node.js:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-typescript",children:'import Scaffold from "simple-scaffold"\n\nconst config = {\n name: "component",\n templates: [path.join(__dirname, "scaffolds", "component")],\n output: path.join(__dirname, "src", "components"),\n createSubFolder: true,\n subFolderNameHelper: "upperCase"\n data: {\n property: "value",\n },\n helpers: {\n twice: (text) => [text, text].join(" ")\n },\n // return a string to replace the final file contents after pre-processing, or `undefined`\n // to keep it as-is\n beforeWrite: (content, rawContent, outputPath) => content.toString().toUpperCase()\n}\n\nconst scaffold = Scaffold(config)\n'})})]})}function f(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},3108:(e,n,t)=>{t.d(n,{Z:()=>a,a:()=>i});var o=t(959);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.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:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]);

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1 @@
(()=>{"use strict";var e,t,r,a,o,f={},n={};function d(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=f,d.c=n,e=[],d.O=(t,r,a,o)=>{if(!r){var f=1/0;for(b=0;b<e.length;b++){r=e[b][0],a=e[b][1],o=e[b][2];for(var n=!0,c=0;c<r.length;c++)(!1&o||f>=o)&&Object.keys(d.O).every((e=>d.O[e](r[c])))?r.splice(c--,1):(n=!1,o<f&&(f=o));if(n){e.splice(b--,1);var i=a();void 0!==i&&(t=i)}}return t}o=o||0;for(var b=e.length;b>0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,d.d(o,f),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",74:"4c5c6dbb",85:"1f391b9e",92:"5873b104",189:"3bd150b0",237:"1df93b7f",300:"e999734b",306:"f6aebfbf",368:"a94703ab",403:"1e37097f",414:"393be207",518:"a7bd4aaa",597:"5e8c322a",661:"5e95c892",681:"6ff67fd4",879:"6cd1f720",886:"25a6218c",902:"38e469bb",905:"0331ca43",918:"17896441"}[e]||e)+"."+{53:"005b8f98",74:"5eacaab7",85:"e9b047d6",92:"f237827c",189:"4ebc7deb",237:"7295f1e5",300:"63a9e387",306:"313c9c69",338:"0beb2582",368:"5deedc8c",382:"8ca22cea",403:"adcb7acc",414:"76572216",518:"045dd691",597:"9531cb9c",661:"09e7dcbc",681:"8207ab99",879:"dde22d01",886:"df9e002f",902:"86d7ca7d",905:"8282d5d7",918:"eabd22df"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="simple-scaffold-docs:",d.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,c;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b<i.length;b++){var l=i[b];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){n=l;break}}n||(c=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,d.nc&&n.setAttribute("nonce",d.nc),n.setAttribute("data-webpack",o+r),n.src=e),a[e]=[t];var s=(t,r)=>{n.onerror=n.onload=null,clearTimeout(u);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},u=setTimeout(s.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=s.bind(null,n.onerror),n.onload=s.bind(null,n.onload),c&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/simple-scaffold/",d.gca=function(e){return e={17896441:"918","935f2afb":"53","4c5c6dbb":"74","1f391b9e":"85","5873b104":"92","3bd150b0":"189","1df93b7f":"237",e999734b:"300",f6aebfbf:"306",a94703ab:"368","1e37097f":"403","393be207":"414",a7bd4aaa:"518","5e8c322a":"597","5e95c892":"661","6ff67fd4":"681","6cd1f720":"879","25a6218c":"886","38e469bb":"902","0331ca43":"905"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=d.p+d.u(t),n=new Error;d.l(f,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],c=r[2],i=0;if(f.some((t=>0!==e[t]))){for(a in n)d.o(n,a)&&(d.m[a]=n[a]);if(c)var b=c(d)}for(t&&t(r);i<f.length;i++)o=f[i],d.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return d.O(b)},r=self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();

View File

@@ -1 +0,0 @@
(()=>{"use strict";var e,t,r,a,o,f={},n={};function c(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=f,c.c=n,e=[],c.O=(t,r,a,o)=>{if(!r){var f=1/0;for(b=0;b<e.length;b++){r=e[b][0],a=e[b][1],o=e[b][2];for(var n=!0,d=0;d<r.length;d++)(!1&o||f>=o)&&Object.keys(c.O).every((e=>c.O[e](r[d])))?r.splice(d--,1):(n=!1,o<f&&(f=o));if(n){e.splice(b--,1);var i=a();void 0!==i&&(t=i)}}return t}o=o||0;for(var b=e.length;b>0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,c.d(o,f),o},c.d=(e,t)=>{for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((t,r)=>(c.f[r](e,t),t)),[])),c.u=e=>"assets/js/"+({53:"935f2afb",74:"4c5c6dbb",85:"1f391b9e",92:"5873b104",189:"3bd150b0",237:"1df93b7f",300:"e999734b",306:"f6aebfbf",368:"a94703ab",403:"1e37097f",414:"393be207",518:"a7bd4aaa",597:"5e8c322a",661:"5e95c892",681:"6ff67fd4",879:"6cd1f720",886:"25a6218c",902:"38e469bb",905:"0331ca43",918:"17896441"}[e]||e)+"."+{53:"005b8f98",74:"5eacaab7",85:"fb84bd49",92:"2f936945",189:"65cacc99",205:"a504205b",237:"ab0b7687",300:"523ecf00",306:"aad749f6",368:"ce5eb4f8",403:"ef8c6470",414:"8d59245f",463:"1a7f0802",518:"29c729f3",597:"f09c6a0d",661:"35d85233",681:"8dd4c091",879:"dde22d01",886:"38ada17f",902:"6f4770ff",905:"9233514f",918:"1fa4b72c"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="simple-scaffold-docs:",c.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,d;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b<i.length;b++){var l=i[b];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){n=l;break}}n||(d=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,c.nc&&n.setAttribute("nonce",c.nc),n.setAttribute("data-webpack",o+r),n.src=e),a[e]=[t];var s=(t,r)=>{n.onerror=n.onload=null,clearTimeout(u);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},u=setTimeout(s.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=s.bind(null,n.onerror),n.onload=s.bind(null,n.onload),d&&document.head.appendChild(n)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/simple-scaffold/",c.gca=function(e){return e={17896441:"918","935f2afb":"53","4c5c6dbb":"74","1f391b9e":"85","5873b104":"92","3bd150b0":"189","1df93b7f":"237",e999734b:"300",f6aebfbf:"306",a94703ab:"368","1e37097f":"403","393be207":"414",a7bd4aaa:"518","5e8c322a":"597","5e95c892":"661","6ff67fd4":"681","6cd1f720":"879","25a6218c":"886","38e469bb":"902","0331ca43":"905"}[e]||e,c.p+c.u(e)},(()=>{var e={303:0,532:0};c.f.j=(t,r)=>{var a=c.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=c.p+c.u(t),n=new Error;c.l(f,(r=>{if(c.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],d=r[2],i=0;if(f.some((t=>0!==e[t]))){for(a in n)c.o(n,a)&&(c.m[a]=n[a]);if(d)var b=d(c)}for(t&&t(r);i<f.length;i++)o=f[i],c.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return c.O(b)},r=self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -5,14 +5,14 @@
<meta name="generator" content="Docusaurus v3.1.1">
<title data-rh="true">Markdown page example | Simple Scaffold</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://chenasraf.github.io/simple-scaffold/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://chenasraf.github.io/simple-scaffold/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://chenasraf.github.io/simple-scaffold/markdown-page"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Markdown page example | Simple Scaffold"><meta data-rh="true" name="description" content="You don&#x27;t need React to write simple standalone pages."><meta data-rh="true" property="og:description" content="You don&#x27;t need React to write simple standalone pages."><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.svg"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/markdown-page"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/markdown-page" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/markdown-page" hreflang="x-default"><link rel="preconnect" href="https://www.googletagmanager.com">
<script>window.dataLayer=window.dataLayer||[]</script>
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-KHQS9TQ",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script><link rel="stylesheet" href="/simple-scaffold/assets/css/styles.8a64fb18.css">
<script src="/simple-scaffold/assets/js/runtime~main.dee86462.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.10ddefdb.js" defer="defer"></script>
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-KHQS9TQ",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script><link rel="stylesheet" href="/simple-scaffold/assets/css/styles.8f35b0a8.css">
<script src="/simple-scaffold/assets/js/runtime~main.bdfbcd33.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.0712a387.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KHQS9TQ" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_xD9F" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/simple-scaffold/"><div class="navbar__logo"><img src="/simple-scaffold/img/favicon.svg" alt="Simple Scaffold" class="themedComponent_RIc6 themedComponent--light_aQWN"><img src="/simple-scaffold/img/favicon.svg" alt="Simple Scaffold" class="themedComponent_RIc6 themedComponent--dark_XAeT"></div><b class="navbar__title text--truncate">Simple Scaffold</b></a><a class="navbar__item navbar__link" href="/simple-scaffold/docs/api/">API</a><a class="navbar__item navbar__link" href="/simple-scaffold/docs/usage/">Usage</a></div><div class="navbar__items navbar__items--right"><a href="https://npmjs.com/package/simple-scaffold" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">NPM<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://github.com/chenasraf/simple-scaffold" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_N2tU colorModeToggle_R3HC"><button class="clean-btn toggleButton_TIRg toggleButtonDisabled_Dghz" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_T53_"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_erRR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_YstM"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_DnkQ"><main class="container container--fluid margin-vert--lg"><div class="row mdxPageWrapper_tS8w"><div class="col col--8"><article><h1>Markdown page example</h1>
<p>You don&#x27;t need React to write simple standalone pages.</p></article></div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/simple-scaffold/docs/intro">Tutorial</a></li></ul></div><div class="col footer__col"><div class="footer__title">More from @casraf</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://chenasraf.github.io/massarg" target="_blank" rel="noopener noreferrer" class="footer__link-item">Massarg - CLI Argument Parser<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://casraf.dev" target="_blank" rel="noopener noreferrer" class="footer__link-item">Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://npmjs.com/package/simple-scaffold" target="_blank" rel="noopener noreferrer" class="footer__link-item">npm<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/chenasraf/simple-scaffold" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 Chen Asraf. Built with Docusaurus.</div></div></div></footer></div>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_rQlL" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/simple-scaffold/"><div class="navbar__logo"><img src="/simple-scaffold/img/favicon.svg" alt="Simple Scaffold" class="themedComponent_RIc6 themedComponent--light_aQWN"><img src="/simple-scaffold/img/favicon.svg" alt="Simple Scaffold" class="themedComponent_RIc6 themedComponent--dark_XAeT"></div><b class="navbar__title text--truncate">Simple Scaffold</b></a><a class="navbar__item navbar__link" href="/simple-scaffold/docs/api/">API</a><a class="navbar__item navbar__link" href="/simple-scaffold/docs/usage/">Usage</a></div><div class="navbar__items navbar__items--right"><a href="https://npmjs.com/package/simple-scaffold" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">NPM<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_sBME"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><a href="https://github.com/chenasraf/simple-scaffold" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_sBME"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_oIpX colorModeToggle_l_kR"><button class="clean-btn toggleButton_nBzH toggleButtonDisabled_a7ym" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_SPZf"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_uyPs"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_n_9q"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_e4zP"><main class="container container--fluid margin-vert--lg"><div class="row mdxPageWrapper_Fy2D"><div class="col col--8"><article><h1>Markdown page example</h1>
<p>You don&#x27;t need React to write simple standalone pages.</p></article></div></div></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/simple-scaffold/docs/intro">Tutorial</a></li></ul></div><div class="col footer__col"><div class="footer__title">More from @casraf</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://chenasraf.github.io/massarg" target="_blank" rel="noopener noreferrer" class="footer__link-item">Massarg - CLI Argument Parser<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_sBME"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://casraf.dev" target="_blank" rel="noopener noreferrer" class="footer__link-item">Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_sBME"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://npmjs.com/package/simple-scaffold" target="_blank" rel="noopener noreferrer" class="footer__link-item">npm<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_sBME"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/chenasraf/simple-scaffold" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_sBME"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 Chen Asraf. Built with Docusaurus.</div></div></div></footer></div>
</body>
</html>