Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
spec.json",id:"test-specjson",level:4},{value:"Look up xrefs",id:"look-up-xrefs",level:4},{value:"Create index.html",id:"create-indexhtml",level:4},{value:"You are ready",id:"you-are-ready",level:4},{value:"View your specification",id:"view-your-specification",level:4},{value:"Three different modes",id:"three-different-modes",level:4},{value:"Automation",id:"automation",level:4}];function a(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h4:"h4",li:"li",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"general-guide",children:"General Guide"}),"\n",(0,s.jsx)(n.p,{children:"These are general instructions for every role involved."}),"\n",(0,s.jsx)(n.p,{children:"The following instructions should be entered into a terminal (command line):"}),"\n",(0,s.jsxs)(n.h4,{id:"test-specjson",children:["Test ",(0,s.jsx)(n.code,{children:"spec.json"})]}),"\n",(0,s.jsxs)(n.p,{children:["Once you have edited the ",(0,s.jsx)(n.code,{children:"spec.json,"})," you can test here to see if it is OK; that is, it checks whether each key is present. It does not check whether the value of the key meets specific rules:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run validatespec\n"})}),"\n",(0,s.jsx)(n.p,{children:"If a key is missing you will get a notification about it."}),"\n",(0,s.jsx)(n.h4,{id:"look-up-xrefs",children:"Look up xrefs"}),"\n",(0,s.jsx)(n.p,{children:"Xrefs are [To Do: write explanation]"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run xrefs\n"})}),"\n",(0,s.jsx)(n.p,{children:"Now, the references to external specs are generated, if any."}),"\n",(0,s.jsx)(n.h4,{id:"create-indexhtml",children:"Create index.html"}),"\n",(0,s.jsxs)(n.p,{children:["The final result will be just one file: ",(0,s.jsx)(n.code,{children:"index.html"}),". This file is rendered or re-rendered with the following command:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run render\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Now, an index.html file is created in the ",(0,s.jsx)(n.code,{children:"docs"})," directory. This is the default directory specified in the ",(0,s.jsx)(n.code,{children:"specs.json"})," file."]}),"\n",(0,s.jsx)(n.h4,{id:"you-are-ready",children:"You are ready"}),"\n",(0,s.jsxs)(n.p,{children:["Now you have a basic Spec-Up-T specification file (",(0,s.jsx)(n.code,{children:"index.html"}),") with the following content:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["a ",(0,s.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,s.jsxs)(n.li,{children:["a ",(0,s.jsx)(n.code,{children:"spec/"})," directory with sample markdown files"]}),"\n",(0,s.jsxs)(n.li,{children:["a ",(0,s.jsx)(n.code,{children:"docs"})," directory with a sample index.html file"]}),"\n",(0,s.jsxs)(n.li,{children:["a ",(0,s.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,s.jsx)(n.code,{children:"package.json"})," file, and a ",(0,s.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,s.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,s.jsx)(n.h4,{id:"view-your-specification",children:"View your specification"}),"\n",(0,s.jsxs)(n.p,{children:["So the ",(0,s.jsx)(n.code,{children:"index.html"})," is the endresult. You should view it in a browser. There are two ways to do this:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["via ",(0,s.jsx)(n.code,{children:"http://"})]}),"\n",(0,s.jsxs)(n.li,{children:["via ",(0,s.jsx)(n.code,{children:"file:///"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The simplest way to do so is via ",(0,s.jsx)(n.code,{children:"file:///"}),": go to the ",(0,s.jsx)(n.code,{children:"index.html"})," file with your Explorer, Finder, or other file manager, and double-click on it. Usually, it now opens in your browser."]}),"\n",(0,s.jsx)(n.p,{children:"If not, go to the browser and try to open the file from the browser menu."}),"\n",(0,s.jsxs)(n.p,{children:["This way, you open the ",(0,s.jsx)(n.code,{children:"index.html"})," file via the ",(0,s.jsx)(n.code,{children:"file protocol"})," (\u201c",(0,s.jsx)(n.code,{children:"file:///"}),"\u201d)."]}),"\n",(0,s.jsxs)(n.p,{children:["You can also access it via HTTP. You then need to place the ",(0,s.jsx)(n.code,{children:"index.html"})," file on a web server and access it through a browser using the URL under which the file is accessible."]}),"\n",(0,s.jsx)(n.p,{children:"This way, you can share it with the world by sharing the URL."}),"\n",(0,s.jsx)(n.admonition,{type:"info",children:(0,s.jsx)(n.p,{children:"HTTP stands for HyperText Transfer Protocol. It is the foundation of any data exchange on the Web and a protocol for transmitting hypertext requests and information online. The World Wide Web uses HTTP and defines how messages are formatted and transmitted and how web servers and browsers should respond to various commands."})}),"\n",(0,s.jsx)(n.h4,{id:"three-different-modes",children:"Three different modes"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"npm run render"})," is not the only way to go. There are three different modes for rendering the specification:"]}),"\n",(0,s.jsxs)(n.table,{children:[(0,s.jsx)(n.thead,{children:(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.th,{children:"command"}),(0,s.jsx)(n.th,{children:"behavior"})]})}),(0,s.jsxs)(n.tbody,{children:[(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"npm run edit"})}),(0,s.jsxs)(n.td,{children:["After rendering, this will stay running, and the ",(0,s.jsx)(n.code,{children:"gulp"})," library will watch the source files in your spec directory/ies for changes and re-render any time you save a file. Opening these rendered files in a browser and refreshing them will keep you up to date."]})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"npm run render"})}),(0,s.jsx)(n.td,{children:"This renders the site once and does not keep a gulpy watch on the underlying files."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.code,{children:"npm run dev"})}),(0,s.jsx)(n.td,{children:"this enables debugging features."})]})]})]}),"\n",(0,s.jsx)(n.h4,{id:"automation",children:"Automation"}),"\n",(0,s.jsxs)(n.p,{children:["The above scripts can easily be triggered by ",(0,s.jsx)(n.a,{href:"../glossary#github-actions",children:"github actions"}),". See ",(0,s.jsx)(n.a,{href:"https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml",children:"this repo's example"})]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>d});var s=i(6540);const r={},t=s.createContext(r);function o(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/dff1e1e9.6a113c6e.js b/assets/js/dff1e1e9.6a113c6e.js
new file mode 100644
index 00000000..430ae1e8
--- /dev/null
+++ b/assets/js/dff1e1e9.6a113c6e.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8838],{2234:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>l});var i=r(4848),s=r(8453);const o={sidebar_position:3},t="General Guide",d={id:"various-roles/general-guide",title:"General Guide",description:"These are general instructions. This is a temporary page; parts will be moved to other pages and assigned to the various roles.",source:"@site/docs/various-roles/general-guide.md",sourceDirName:"various-roles",slug:"/various-roles/general-guide",permalink:"/spec-up-t-website/docs/various-roles/general-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/general-guide.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3},sidebar:"tutorialSidebar",previous:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"},next:{title:"Content Authors Guide",permalink:"/spec-up-t-website/docs/category/content-authors-guide"}},c={},l=[{value:"Create spec.json",id:"create--specjson",level:2},{value:"Test spec.json",id:"test-specjson",level:2},{value:"Look up xrefs",id:"look-up-xrefs",level:2},{value:"Remove xref",id:"remove-xref",level:2},{value:"Create index.html",id:"create-indexhtml",level:2},{value:"You are ready",id:"you-are-ready",level:2},{value:"View your specification",id:"view-your-specification",level:2},{value:"Three different modes",id:"three-different-modes",level:2},{value:"Automation",id:"automation",level:2}];function a(e){const n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"general-guide",children:"General Guide"}),"\n",(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsx)(n.p,{children:"These are general instructions. This is a temporary page; parts will be moved to other pages and assigned to the various roles."})}),"\n",(0,i.jsxs)(n.h2,{id:"create--specjson",children:["Create ",(0,i.jsx)(n.code,{children:"spec.json"})]}),"\n",(0,i.jsxs)(n.p,{children:["The",(0,i.jsx)(n.code,{children:"specs.json"})," file ",(0,i.jsx)(n.strong,{children:"in the root folder of your repository"})," specifies configuration values used in the generation of your spec documents. The values in your ",(0,i.jsx)(n.code,{children:"specs.json"})," file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the ",(0,i.jsx)(n.code,{children:"specs.json"})," config file:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"public_root"})})," ",(0,i.jsx)(n.em,{children:"(PATH STRING, optional)"})," - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the ",(0,i.jsx)(n.code,{children:"public_root"})," property to specify the insertion of a path segment to account for the difference in pathing between your local renders and wherever you publish your spec."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"specs"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, required)"})," - the ",(0,i.jsx)(n.code,{children:"specs"})," array contains descriptor objects for each of the specs you are generating in your project and are composed of the following required and optional properties:"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"spec_directory"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must specify the ",(0,i.jsx)(n.strong,{children:"repo-root-relative"})," location of your spec's markdown file directory. You ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.strong,{children:"MUST"})})," name your spec's markdown file ",(0,i.jsx)(n.code,{children:"spec.md"})," and locate it in your ",(0,i.jsx)(n.code,{children:"spec_directory"})," so the tool can automatically find and use it for rendering. If you want to use a different name for the markdown file, or you have multiple markdown files you would like the tool to assemble into one document, you must specify them using the optional",(0,i.jsx)(n.code,{children:"markdown_paths"}),' field described below. See the "multi-file" example in the spec-up repo.']}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"title"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must add a title for your spec, which will be rendered in the generated document's H1 text and page title."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo"})})," ",(0,i.jsx)(n.em,{children:"(PATH/URI STRING, optional)"})," - You may add a reference to a logo asset, either via a path to the asset or a URI"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo_link"})})," ",(0,i.jsx)(n.em,{children:"(URI STRING, optional)"})," - The URI you want your logo to point to on the rendered page."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"markdown_paths"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, optional)"})," - If you want to name your spec's markdown file something other than ",(0,i.jsx)(n.code,{children:"spec.md"}),", or you have multiple files you would like assembled into a single output document, you must specify their paths as array entries in the order you would like them assembled. The paths in this array are assumed to be based on the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified, so ",(0,i.jsx)(n.em,{children:"DO NOT"})," repeat the full root relative path."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"katex"})})," ",(0,i.jsx)(n.em,{children:"(BOOLEAN, optional)"})," - To enable TeX support via KaTeX, set this property to ",(0,i.jsx)(n.code,{children:"true"}),". After rendering, be sure to copy the ",(0,i.jsx)(n.code,{children:"fonts/"})," subdirectory containing the necessary web fonts."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"output_path"})})," ",(0,i.jsx)(n.em,{children:"(STRING, optional)"})," - If you want the generated spec document to be output to a different location than the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified (e.g. the project root for GitHub Pages publishing), you can specify another root relative path (use ",(0,i.jsx)(n.code,{children:"./"})," for root), and the tool will write the document file there instead."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"source"})})," ",(0,i.jsx)(n.em,{children:"(OBJECT, optional)"})," - this object allows you to configure where repo-specific data is pulled from to power some of the more advanced repo-related features. To do this, specify the code hosting service by adding a service ID string to ",(0,i.jsx)(n.code,{children:"host"})," (currently Spec-Up only supports ",(0,i.jsx)(n.code,{children:'"github"'}),", but this is extensible), add the account/org the repo is located within via the ",(0,i.jsx)(n.code,{children:"account"})," property, and add the repo name under the ",(0,i.jsx)(n.code,{children:"repo"})," property. Here is an example configuration:"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n"host": "github",\n"account": "decentralized-identity",\n"repo": "sidetree"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate."}),"\n",(0,i.jsxs)(n.h2,{id:"test-specjson",children:["Test ",(0,i.jsx)(n.code,{children:"spec.json"})]}),"\n",(0,i.jsxs)(n.p,{children:["Once you have edited the ",(0,i.jsx)(n.code,{children:"spec.json,"})," you can test here to see if it is OK; that is, it checks whether each key is present. It does not check whether the value of the key meets specific rules:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npm run validatespec\n"})}),"\n",(0,i.jsx)(n.p,{children:"If a key is missing you will get a notification about it."}),"\n",(0,i.jsxs)(n.h2,{id:"look-up-xrefs",children:["Look up ",(0,i.jsx)(n.code,{children:"xrefs"})]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"xrefs"})," are references to external glossaries (specifications)."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npm run xrefs\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now, the ",(0,i.jsx)(n.code,{children:"xref"})," is generated, if any."]}),"\n",(0,i.jsxs)(n.p,{children:["Every ",(0,i.jsx)(n.code,{children:"xref"})," is checked against a local data collection to see if there is already a reference. If so, it is left untouched. This way, every xref will point to the definition as it was created. If the external term changes in the meantime, the reference is still to the original version."]}),"\n",(0,i.jsxs)(n.h2,{id:"remove-xref",children:["Remove ",(0,i.jsx)(n.code,{children:"xref"})]}),"\n",(0,i.jsxs)(n.p,{children:["Removing an ",(0,i.jsx)(n.code,{children:"xref"})," from the text is something you'll do via the text editor. However, if you want to update the xref and make it point to the current version of the external reference, remove the current reference that might point to an older version:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:'npm run removexref -- "termValue" "externalSpecValue"\n'})}),"\n",(0,i.jsxs)(n.p,{children:["After that, you can run ",(0,i.jsx)(n.code,{children:"npm run xrefs"})," again to get the latest reference (that might be identical if the external reference did not change)."]}),"\n",(0,i.jsx)(n.h2,{id:"create-indexhtml",children:"Create index.html"}),"\n",(0,i.jsxs)(n.p,{children:["The final result will be just one file: ",(0,i.jsx)(n.code,{children:"index.html"}),". This file is rendered or re-rendered with the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npm run render\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now, an index.html file is created in the ",(0,i.jsx)(n.code,{children:"docs"})," directory. This is the default directory specified in the ",(0,i.jsx)(n.code,{children:"specs.json"})," file."]}),"\n",(0,i.jsx)(n.h2,{id:"you-are-ready",children:"You are ready"}),"\n",(0,i.jsxs)(n.p,{children:["Now you have a basic Spec-Up-T specification file (",(0,i.jsx)(n.code,{children:"index.html"}),") with the following content:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"spec/"})," directory with sample markdown files"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"docs"})," directory with a sample index.html file"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,i.jsx)(n.code,{children:"package.json"})," file, and a ",(0,i.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,i.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"view-your-specification",children:"View your specification"}),"\n",(0,i.jsxs)(n.p,{children:["So the ",(0,i.jsx)(n.code,{children:"index.html"})," is the endresult. You should view it in a browser. There are two ways to do this:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["via ",(0,i.jsx)(n.code,{children:"http://"})]}),"\n",(0,i.jsxs)(n.li,{children:["via ",(0,i.jsx)(n.code,{children:"file:///"})]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["The simplest way to do so is via ",(0,i.jsx)(n.code,{children:"file:///"}),": go to the ",(0,i.jsx)(n.code,{children:"index.html"})," file with your Explorer, Finder, or other file manager, and double-click on it. Usually, it now opens in your browser."]}),"\n",(0,i.jsx)(n.p,{children:"If not, go to the browser and try to open the file from the browser menu."}),"\n",(0,i.jsxs)(n.p,{children:["This way, you open the ",(0,i.jsx)(n.code,{children:"index.html"})," file via the ",(0,i.jsx)(n.code,{children:"file protocol"})," (\u201c",(0,i.jsx)(n.code,{children:"file:///"}),"\u201d)."]}),"\n",(0,i.jsxs)(n.p,{children:["You can also access it via HTTP. You then need to place the ",(0,i.jsx)(n.code,{children:"index.html"})," file on a web server and access it through a browser using the URL under which the file is accessible."]}),"\n",(0,i.jsx)(n.p,{children:"This way, you can share it with the world by sharing the URL."}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsx)(n.p,{children:"HTTP stands for HyperText Transfer Protocol. It is the foundation of any data exchange on the Web and a protocol for transmitting hypertext requests and information online. The World Wide Web uses HTTP and defines how messages are formatted and transmitted and how web servers and browsers should respond to various commands."})}),"\n",(0,i.jsx)(n.h2,{id:"three-different-modes",children:"Three different modes"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"npm run render"})," is not the only way to go. There are three different modes for rendering the specification:"]}),"\n",(0,i.jsxs)(n.table,{children:[(0,i.jsx)(n.thead,{children:(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.th,{children:"command"}),(0,i.jsx)(n.th,{children:"behavior"})]})}),(0,i.jsxs)(n.tbody,{children:[(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"npm run edit"})}),(0,i.jsxs)(n.td,{children:["After rendering, this will stay running, and the ",(0,i.jsx)(n.code,{children:"gulp"})," library will watch the source files in your spec directory/ies for changes and re-render any time you save a file. Opening these rendered files in a browser and refreshing them will keep you up to date."]})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"npm run render"})}),(0,i.jsx)(n.td,{children:"This renders the site once and does not keep a gulpy watch on the underlying files."})]}),(0,i.jsxs)(n.tr,{children:[(0,i.jsx)(n.td,{children:(0,i.jsx)(n.code,{children:"npm run dev"})}),(0,i.jsx)(n.td,{children:"this enables debugging features."})]})]})]}),"\n",(0,i.jsx)(n.h2,{id:"automation",children:"Automation"}),"\n",(0,i.jsxs)(n.p,{children:["The above scripts can easily be triggered by ",(0,i.jsx)(n.a,{href:"../glossary#github-actions",children:"github actions"}),". See ",(0,i.jsx)(n.a,{href:"https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml",children:"this repo's example"})]})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>d});var i=r(6540);const s={},o=i.createContext(s);function t(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/e2c9a94b.131ae0f3.js b/assets/js/e2c9a94b.131ae0f3.js
new file mode 100644
index 00000000..41825f1b
--- /dev/null
+++ b/assets/js/e2c9a94b.131ae0f3.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[1070],{8294:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>a});var i=s(4848),t=s(8453);const o={sidebar_position:2},l="Admins Guide",r={id:"various-roles/admins-guide",title:"Admins Guide",description:"This is the admin guide for the Spec-Up-T system.",source:"@site/docs/various-roles/admins-guide.md",sourceDirName:"various-roles",slug:"/various-roles/admins-guide",permalink:"/spec-up-t-website/docs/various-roles/admins-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/admins-guide.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Intro",permalink:"/spec-up-t-website/docs/various-roles/intro"},next:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"}},d={},a=[{value:"Installation",id:"installation",level:2},{value:"Short video",id:"short-video",level:3},{value:"Getting Started",id:"getting-started",level:3},{value:"What you'll need",id:"what-youll-need",level:3},{value:"Install a new site",id:"install-a-new-site",level:3},{value:"General info",id:"general-info",level:4},{value:"Install a new Spec-Up-T site",id:"install-a-new-spec-up-t-site",level:4},{value:"Go into the directory",id:"go-into-the-directory",level:4},{value:"Install all dependencies",id:"install-all-dependencies",level:4},{value:"Add repo to Github",id:"add-repo-to-github",level:4},{value:"Edit specs.json",id:"edit-specsjson",level:5},{value:"Push repo to GitHub",id:"push-repo-to-github",level:5}];function c(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"admins-guide",children:"Admins Guide"}),"\n",(0,i.jsx)(n.p,{children:"This is the admin guide for the Spec-Up-T system."}),"\n",(0,i.jsxs)(n.p,{children:["The repo can be found ",(0,i.jsx)(n.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"here"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsx)(n.h3,{id:"short-video",children:"Short video"}),"\n",(0,i.jsxs)(n.p,{children:["Let's install ",(0,i.jsx)(n.strong,{children:"Spec-Up-T"}),". This short video shows the process."]}),"\n",(0,i.jsxs)("video",{controls:!0,children:[(0,i.jsx)("source",{src:s(6525).A,type:"video/mp4"}),(0,i.jsx)(n.p,{children:"Your browser does not support video tags."})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{target:"_blank","data-noBrokenLinkCheck":!0,href:s(8948).A+"",children:"Link to the video"})}),"\n",(0,i.jsx)(n.h3,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(n.p,{children:["Now, let's do it ourselves. Get started by ",(0,i.jsx)(n.strong,{children:"creating a new site"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"what-youll-need",children:"What you'll need"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://nodejs.org/en/download/",children:"Node.js"}),":","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When installing Node.js, you are recommended to check all checkboxes related to dependencies."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Web_browser",children:"webbrowser"}),". You are probably reading this in a browser, so you already have one."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"install-a-new-site",children:"Install a new site"}),"\n",(0,i.jsx)(n.h4,{id:"general-info",children:"General info"}),"\n",(0,i.jsx)(n.p,{children:"Installing Spec-Up-T works similarly to installing any other npm package. You install it locally (not globally), and then you run it."}),"\n",(0,i.jsx)(n.h4,{id:"install-a-new-spec-up-t-site",children:"Install a new Spec-Up-T site"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"my-spec-up-t-website"})," can be anything you want it to be (however, it is recommended to not use spaces or special characters in directory names)."]}),"\n",(0,i.jsx)(n.p,{children:"You can also omit the last part:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you omit ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"}),", a default directory name, namely ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack,"})," is used."]}),"\n",(0,i.jsx)(n.p,{children:"Sometimes, you want to force the latest version to be installed. Then you can do the following:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t@latest my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet)."}),"\n",(0,i.jsxs)(n.p,{children:["You should now have a directory called ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"})," (or ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack"})," if you did not specify a name)."]}),"\n",(0,i.jsx)(n.h4,{id:"go-into-the-directory",children:"Go into the directory"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Go into this directory (folder) that was just created:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"cd my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You are now in this directory."}),"\n",(0,i.jsx)(n.h4,{id:"install-all-dependencies",children:"Install all dependencies"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Install all dependencies:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"npm run install\n"})}),"\n",(0,i.jsx)(n.p,{children:"It can take some time, and you should see multiple lines of output during installation."}),"\n",(0,i.jsx)(n.p,{children:"When the prompt is visible again, you should now have a basic Spec-Up-T install:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"spec/"})," directory with sample markdown files"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,i.jsx)(n.code,{children:"package.json"})," file, and a ",(0,i.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,i.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"What you don't have yet is the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"docs"})," directory with a sample ",(0,i.jsx)(n.code,{children:"index.html"})," file (which is the actual specification file that is the goal of it all)."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["How to do this, go to the ",(0,i.jsx)(n.a,{href:"/spec-up-t-website/docs/various-roles/general-guide",children:"General Instructions"}),"."]}),"\n",(0,i.jsx)(n.h4,{id:"add-repo-to-github",children:"Add repo to Github"}),"\n",(0,i.jsx)(n.p,{children:"You should push your new specification (i.e. the sample content) to a GitHub repo."}),"\n",(0,i.jsx)(n.p,{children:"These are the steps to take:"}),"\n",(0,i.jsxs)(n.h5,{id:"edit-specsjson",children:["Edit ",(0,i.jsx)(n.code,{children:"specs.json"})]}),"\n",(0,i.jsxs)(n.p,{children:["Change this entry in ",(0,i.jsx)(n.code,{children:"specs.json"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'"source": {\n "host": "github",\n "account": "blockchainbird",\n "repo": "spec-up-t-starter-pack"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:"to the correct information:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'"source": {\n "host": "github",\n "account": "your-account",\n "repo": "your-repo"\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:"These are the host (GitHub), your GitHub account name, and the repo name of the repo you are about to push."}),"\n",(0,i.jsx)(n.h5,{id:"push-repo-to-github",children:"Push repo to GitHub"}),"\n",(0,i.jsx)(n.p,{children:"Now, push the repo to GitHub. Use the command line or your preferred way to do this."})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},8948:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/files/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},6525:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/medias/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},8453:(e,n,s)=>{s.d(n,{R:()=>l,x:()=>r});var i=s(6540);const t={},o=i.createContext(t);function l(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/e2c9a94b.ff55a273.js b/assets/js/e2c9a94b.ff55a273.js
deleted file mode 100644
index 7985d0b5..00000000
--- a/assets/js/e2c9a94b.ff55a273.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[1070],{8294:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>d,contentTitle:()=>r,default:()=>h,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var i=s(4848),o=s(8453);const t={sidebar_position:2},r="Admins Guide",l={id:"various-roles/admins-guide",title:"Admins Guide",description:"This is the admin guide for the Spec-Up-T system.",source:"@site/docs/various-roles/admins-guide.md",sourceDirName:"various-roles",slug:"/various-roles/admins-guide",permalink:"/spec-up-t-website/docs/various-roles/admins-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/various-roles/admins-guide.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Intro",permalink:"/spec-up-t-website/docs/various-roles/intro"},next:{title:"Technical skills needed",permalink:"/spec-up-t-website/docs/various-roles/technical-skills-needed"}},d={},c=[{value:"Installation",id:"installation",level:2},{value:"Short video",id:"short-video",level:3},{value:"Getting Started",id:"getting-started",level:3},{value:"What you'll need",id:"what-youll-need",level:3},{value:"Install a new site",id:"install-a-new-site",level:3},{value:"General info",id:"general-info",level:4},{value:"Install a new Spec-Up-T site",id:"install-a-new-spec-up-t-site",level:4},{value:"Go into the directory",id:"go-into-the-directory",level:4},{value:"Install all dependencies",id:"install-all-dependencies",level:4},{value:"More info",id:"more-info",level:3},{value:"The specs.json file",id:"the-specsjson-file",level:4}];function a(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"admins-guide",children:"Admins Guide"}),"\n",(0,i.jsx)(n.p,{children:"This is the admin guide for the Spec-Up-T system."}),"\n",(0,i.jsxs)(n.p,{children:["The repo can be found ",(0,i.jsx)(n.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"here"})]}),"\n",(0,i.jsx)(n.h2,{id:"installation",children:"Installation"}),"\n",(0,i.jsx)(n.h3,{id:"short-video",children:"Short video"}),"\n",(0,i.jsxs)(n.p,{children:["Let's install ",(0,i.jsx)(n.strong,{children:"Spec-Up-T"}),". This short video shows the process."]}),"\n",(0,i.jsxs)("video",{controls:!0,children:[(0,i.jsx)("source",{src:s(6525).A,type:"video/mp4"}),(0,i.jsx)(n.p,{children:"Your browser does not support video tags."})]}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{target:"_blank","data-noBrokenLinkCheck":!0,href:s(8948).A+"",children:"Link to the video"})}),"\n",(0,i.jsx)(n.h3,{id:"getting-started",children:"Getting Started"}),"\n",(0,i.jsxs)(n.p,{children:["Now, let's do it ourselves. Get started by ",(0,i.jsx)(n.strong,{children:"creating a new site"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"what-youll-need",children:"What you'll need"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://nodejs.org/en/download/",children:"Node.js"}),":","\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"When installing Node.js, you are recommended to check all checkboxes related to dependencies."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.a,{href:"https://en.wikipedia.org/wiki/Web_browser",children:"webbrowser"}),". You are probably reading this in a browser, so you already have one."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"install-a-new-site",children:"Install a new site"}),"\n",(0,i.jsx)(n.h4,{id:"general-info",children:"General info"}),"\n",(0,i.jsx)(n.p,{children:"Installing Spec-Up-T works similarly to installing any other npm package. You install it locally (not globally), and then you run it."}),"\n",(0,i.jsx)(n.h4,{id:"install-a-new-spec-up-t-site",children:"Install a new Spec-Up-T site"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.em,{children:"my-spec-up-t-website"})," can be anything you want it to be (however, it is recommended to not use spaces or special characters in directory names)."]}),"\n",(0,i.jsx)(n.p,{children:"You can also omit the last part:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t\n"})}),"\n",(0,i.jsxs)(n.p,{children:["If you omit ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"}),", a default directory name, namely ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack,"})," is used."]}),"\n",(0,i.jsx)(n.p,{children:"Sometimes, you want to force the latest version to be installed. Then you can do the following:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t@latest my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet)."}),"\n",(0,i.jsxs)(n.p,{children:["You should now have a directory called ",(0,i.jsx)(n.code,{children:"my-spec-up-t-website"})," (or ",(0,i.jsx)(n.code,{children:"spec-up-t-starterpack"})," if you did not specify a name)."]}),"\n",(0,i.jsx)(n.h4,{id:"go-into-the-directory",children:"Go into the directory"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Go into this directory (folder) that was just created:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"cd my-spec-up-t-website\n"})}),"\n",(0,i.jsx)(n.p,{children:"You are now in this directory."}),"\n",(0,i.jsx)(n.h4,{id:"install-all-dependencies",children:"Install all dependencies"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Install all dependencies:"}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:"npm run install\n"})}),"\n",(0,i.jsx)(n.p,{children:"It can take some time, and you should see multiple lines of output during installation."}),"\n",(0,i.jsx)(n.p,{children:"When the prompt is visible again, you should now have a basic Spec-Up-T install:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"spec/"})," directory with sample markdown files"]}),"\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"node_modules"})," directory, a ",(0,i.jsx)(n.code,{children:"package.json"})," file, and a ",(0,i.jsx)(n.code,{children:"package-lock.json"})," file (these three elements belong to the ",(0,i.jsx)(n.code,{children:"npm"})," system)"]}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"What you don't have yet is the following:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["a ",(0,i.jsx)(n.code,{children:"docs"})," directory with a sample ",(0,i.jsx)(n.code,{children:"index.html"})," file (which is the actual specification file that is the goal of it all)."]}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["How to do this, go to the ",(0,i.jsx)(n.a,{href:"/spec-up-t-website/docs/various-roles/general-guide",children:"General Instructions"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"more-info",children:"More info"}),"\n",(0,i.jsxs)(n.h4,{id:"the-specsjson-file",children:["The ",(0,i.jsx)(n.code,{children:"specs.json"})," file"]}),"\n",(0,i.jsxs)(n.p,{children:["The",(0,i.jsx)(n.code,{children:"specs.json"})," file ",(0,i.jsx)(n.strong,{children:"in the root folder of your repository"})," specifies configuration values used in the generation of your spec documents. The values in your ",(0,i.jsx)(n.code,{children:"specs.json"})," file include things like where your spec's markdown files are located, where to output the generated spec document, and various metadata values used in rendering, such as the title, logo, and repo links for each of your specs. The following are the required/optional fields supported in the ",(0,i.jsx)(n.code,{children:"specs.json"})," config file:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"public_root"})})," ",(0,i.jsx)(n.em,{children:"(PATH STRING, optional)"})," - For some platforms and services where you may want to output your rendered spec, the pathing may differ from the directory structure of your local project. To account for this, you can use the ",(0,i.jsx)(n.code,{children:"public_root"})," property to specify the insertion of a path segment to account for the difference in pathing between your local renders and wherever you publish your spec."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"specs"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, required)"})," - the ",(0,i.jsx)(n.code,{children:"specs"})," array contains descriptor objects for each of the specs you are generating in your project and are composed of the following required and optional properties:"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"spec_directory"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must specify the ",(0,i.jsx)(n.strong,{children:"repo-root-relative"})," location of your spec's markdown file directory. You ",(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.strong,{children:"MUST"})})," name your spec's markdown file ",(0,i.jsx)(n.code,{children:"spec.md"})," and locate it in your ",(0,i.jsx)(n.code,{children:"spec_directory"})," so the tool can automatically find and use it for rendering. If you want to use a different name for the markdown file, or you have multiple markdown files you would like the tool to assemble into one document, you must specify them using the optional",(0,i.jsx)(n.code,{children:"markdown_paths"}),' field described below. See the "multi-file" example in the spec-up repo.']}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"title"})})," ",(0,i.jsx)(n.em,{children:"(STRING, required)"})," - You must add a title for your spec, which will be rendered in the generated document's H1 text and page title."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo"})})," ",(0,i.jsx)(n.em,{children:"(PATH/URI STRING, optional)"})," - You may add a reference to a logo asset, either via a path to the asset or a URI"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"logo_link"})})," ",(0,i.jsx)(n.em,{children:"(URI STRING, optional)"})," - The URI you want your logo to point to on the rendered page."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"markdown_paths"})})," ",(0,i.jsx)(n.em,{children:"(ARRAY, optional)"})," - If you want to name your spec's markdown file something other than ",(0,i.jsx)(n.code,{children:"spec.md"}),", or you have multiple files you would like assembled into a single output document, you must specify their paths as array entries in the order you would like them assembled. The paths in this array are assumed to be based on the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified, so ",(0,i.jsx)(n.em,{children:"DO NOT"})," repeat the full root relative path."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"katex"})})," ",(0,i.jsx)(n.em,{children:"(BOOLEAN, optional)"})," - To enable TeX support via KaTeX, set this property to ",(0,i.jsx)(n.code,{children:"true"}),". After rendering, be sure to copy the ",(0,i.jsx)(n.code,{children:"fonts/"})," subdirectory containing the necessary web fonts."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"output_path"})})," ",(0,i.jsx)(n.em,{children:"(STRING, optional)"})," - If you want the generated spec document to be output to a different location than the ",(0,i.jsx)(n.code,{children:"spec_directory"})," you specified (e.g. the project root for GitHub Pages publishing), you can specify another root relative path (use ",(0,i.jsx)(n.code,{children:"./"})," for root), and the tool will write the document file there instead."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:(0,i.jsx)(n.code,{children:"source"})})," ",(0,i.jsx)(n.em,{children:"(OBJECT, optional)"})," - this object allows you to configure where repo-specific data is pulled from to power some of the more advanced repo-related features. To do this, specify the code hosting service by adding a service ID string to ",(0,i.jsx)(n.code,{children:"host"})," (currently Spec-Up only supports ",(0,i.jsx)(n.code,{children:'"github"'}),", but this is extensible), add the account/org the repo is located within via the ",(0,i.jsx)(n.code,{children:"account"})," property, and add the repo name under the ",(0,i.jsx)(n.code,{children:"repo"})," property. Here is an example configuration:"]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{children:'{\n"host": "github",\n"account": "decentralized-identity",\n"repo": "sidetree"\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"You're ready to start rendering specs as HTML sites locally and/or pushing them to github pages however you see fit to automate."})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},8948:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/files/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},6525:(e,n,s)=>{s.d(n,{A:()=>i});const i=s.p+"assets/medias/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},8453:(e,n,s)=>{s.d(n,{R:()=>r,x:()=>l});var i=s(6540);const o={},t=i.createContext(o);function r(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/f049f840.82d3d5ba.js b/assets/js/f049f840.82d3d5ba.js
new file mode 100644
index 00000000..a962a324
--- /dev/null
+++ b/assets/js/f049f840.82d3d5ba.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6418],{483:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Roles","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","href":"/spec-up-t-website/docs/various-roles/intro","docId":"various-roles/intro","unlisted":false},{"type":"link","label":"Admins Guide","href":"/spec-up-t-website/docs/various-roles/admins-guide","docId":"various-roles/admins-guide","unlisted":false},{"type":"link","label":"Technical skills needed","href":"/spec-up-t-website/docs/various-roles/technical-skills-needed","docId":"various-roles/technical-skills-needed","unlisted":false},{"type":"link","label":"General Guide","href":"/spec-up-t-website/docs/various-roles/general-guide","docId":"various-roles/general-guide","unlisted":false},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Content Authors Guide","href":"/spec-up-t-website/docs/various-roles/content-authors-guide/introduction","docId":"various-roles/content-authors-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/content-authors-guide"},{"type":"category","label":"Terminology Author Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Terminology Authors Guide","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction","docId":"various-roles/terminology-authors-guide/introduction","unlisted":false},{"type":"link","label":"Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/term-references","docId":"various-roles/terminology-authors-guide/term-references","unlisted":false},{"type":"link","label":"External Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references","docId":"various-roles/terminology-authors-guide/external-term-references","unlisted":false}],"href":"/spec-up-t-website/docs/category/terminology-author-guide"},{"type":"category","label":"Curators Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Curators Guide","href":"/spec-up-t-website/docs/various-roles/curators-guide/introduction","docId":"various-roles/curators-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/curators-guide"},{"type":"category","label":"Glossary Maintainers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary Maintainers Guide","href":"/spec-up-t-website/docs/various-roles/glossary-maintainers-guide/introduction","docId":"various-roles/glossary-maintainers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/glossary-maintainers-guide"},{"type":"category","label":"Readers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Readers Guide","href":"/spec-up-t-website/docs/various-roles/readers-guide/introduction","docId":"various-roles/readers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/readers-guide"},{"type":"link","label":"Developers Guide","href":"/spec-up-t-website/docs/various-roles/developers-guide","docId":"various-roles/developers-guide","unlisted":false}],"href":"/spec-up-t-website/docs/category/roles"},{"type":"link","label":"Spec-Up-T demo","href":"/spec-up-t-website/docs/spec-up-t-demo-site","docId":"spec-up-t-demo-site","unlisted":false},{"type":"link","label":"How it came to be","href":"/spec-up-t-website/docs/how-it-came-to-be","docId":"how-it-came-to-be","unlisted":false},{"type":"link","label":"Q & A","href":"/spec-up-t-website/docs/q-and-a","docId":"q-and-a","unlisted":false},{"type":"link","label":"Maintaining this site","href":"/spec-up-t-website/docs/this-site-maintainers","docId":"this-site-maintainers","unlisted":false},{"type":"link","label":"Glossary","href":"/spec-up-t-website/docs/glossary","docId":"glossary","unlisted":false},{"type":"link","label":"Troubleshooting","href":"/spec-up-t-website/docs/troubleshooting","docId":"troubleshooting","unlisted":false}]},"docs":{"glossary":{"id":"glossary","title":"Glossary","description":"This is a glossary with some terms that you need to know in order to understand working with Spec-Up-T.","sidebar":"tutorialSidebar"},"how-it-came-to-be":{"id":"how-it-came-to-be","title":"How it came to be","description":"The ToIP Terms extension of Spec-Up","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Intro","sidebar":"tutorialSidebar"},"q-and-a":{"id":"q-and-a","title":"Q & A","description":"Questions and answers about Spec-Up-T.","sidebar":"tutorialSidebar"},"spec-up-t-demo-site":{"id":"spec-up-t-demo-site","title":"Spec-Up-T demo","description":"The Demo","sidebar":"tutorialSidebar"},"this-site-maintainers":{"id":"this-site-maintainers","title":"Maintaining this site","description":"Here you will find information about things specific to this site.","sidebar":"tutorialSidebar"},"troubleshooting":{"id":"troubleshooting","title":"Troubleshooting","description":"Some tips in case of problems:","sidebar":"tutorialSidebar"},"various-roles/admins-guide":{"id":"various-roles/admins-guide","title":"Admins Guide","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/content-authors-guide/introduction":{"id":"various-roles/content-authors-guide/introduction","title":"Content Authors Guide","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/curators-guide/introduction":{"id":"various-roles/curators-guide/introduction","title":"Curators Guide","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/developers-guide":{"id":"various-roles/developers-guide","title":"Developers Guide","description":"This page is the developer\'s guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/general-guide":{"id":"various-roles/general-guide","title":"General Guide","description":"These are general instructions. This is a temporary page; parts will be moved to other pages and assigned to the various roles.","sidebar":"tutorialSidebar"},"various-roles/glossary-maintainers-guide/introduction":{"id":"various-roles/glossary-maintainers-guide/introduction","title":"Glossary Maintainers Guide","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/intro":{"id":"various-roles/intro","title":"Intro","description":"Spec-Up-T implementations can distinguish the following roles:","sidebar":"tutorialSidebar"},"various-roles/readers-guide/introduction":{"id":"various-roles/readers-guide/introduction","title":"Readers Guide","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/technical-skills-needed":{"id":"various-roles/technical-skills-needed","title":"Technical skills needed","description":"Spec-Up-T is a specialized tool designed to facilitate the creation, management, and rendering of technical specifications in a streamlined manner. Users who intend to leverage Spec-Up-T for their projects must possess a foundational level of technical knowledge to navigate the installation, configuration, and utilization of this tool effectively. This article delves into the technical prerequisites necessary for a user to operate Spec-Up-T competently.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/external-term-references":{"id":"various-roles/terminology-authors-guide/external-term-references","title":"External Term References","description":"It is possible to include references to terms from external spec-up generated specifications. To include a source you would like to pull references from include an external_specs array in your spec config. The value should be a key/value object where the key is used in the external reference below and the value is the URL of the external spec.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/introduction":{"id":"various-roles/terminology-authors-guide/introduction","title":"Terminology Authors Guide","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/term-references":{"id":"various-roles/terminology-authors-guide/term-references","title":"Term References","description":"Definition Lists","sidebar":"tutorialSidebar"}}}}')}}]);
\ No newline at end of file
diff --git a/assets/js/f049f840.cd5a2d4e.js b/assets/js/f049f840.cd5a2d4e.js
deleted file mode 100644
index 6739b714..00000000
--- a/assets/js/f049f840.cd5a2d4e.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6418],{483:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"category","label":"Roles","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","href":"/spec-up-t-website/docs/various-roles/intro","docId":"various-roles/intro","unlisted":false},{"type":"link","label":"Admins Guide","href":"/spec-up-t-website/docs/various-roles/admins-guide","docId":"various-roles/admins-guide","unlisted":false},{"type":"link","label":"Technical skills needed","href":"/spec-up-t-website/docs/various-roles/technical-skills-needed","docId":"various-roles/technical-skills-needed","unlisted":false},{"type":"link","label":"General Guide","href":"/spec-up-t-website/docs/various-roles/general-guide","docId":"various-roles/general-guide","unlisted":false},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Content Authors Guide","href":"/spec-up-t-website/docs/various-roles/content-authors-guide/introduction","docId":"various-roles/content-authors-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/content-authors-guide"},{"type":"category","label":"Terminology Author Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Terminology Authors Guide","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/introduction","docId":"various-roles/terminology-authors-guide/introduction","unlisted":false},{"type":"link","label":"Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/term-references","docId":"various-roles/terminology-authors-guide/term-references","unlisted":false},{"type":"link","label":"External Term References","href":"/spec-up-t-website/docs/various-roles/terminology-authors-guide/external-term-references","docId":"various-roles/terminology-authors-guide/external-term-references","unlisted":false}],"href":"/spec-up-t-website/docs/category/terminology-author-guide"},{"type":"category","label":"Curators Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"introduction","href":"/spec-up-t-website/docs/various-roles/curators-guide/introduction","docId":"various-roles/curators-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/curators-guide"},{"type":"category","label":"Glossary Maintainers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary Maintainers Guide","href":"/spec-up-t-website/docs/various-roles/glossary-maintainers-guide/introduction","docId":"various-roles/glossary-maintainers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/glossary-maintainers-guide"},{"type":"category","label":"Readers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Readers Guide","href":"/spec-up-t-website/docs/various-roles/readers-guide/introduction","docId":"various-roles/readers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/readers-guide"},{"type":"link","label":"Developers Guide","href":"/spec-up-t-website/docs/various-roles/developers-guide","docId":"various-roles/developers-guide","unlisted":false}],"href":"/spec-up-t-website/docs/category/roles"},{"type":"link","label":"Spec-Up-T demo","href":"/spec-up-t-website/docs/spec-up-t-demo-site","docId":"spec-up-t-demo-site","unlisted":false},{"type":"link","label":"How it came to be","href":"/spec-up-t-website/docs/how-it-came-to-be","docId":"how-it-came-to-be","unlisted":false},{"type":"link","label":"Q & A","href":"/spec-up-t-website/docs/q-and-a","docId":"q-and-a","unlisted":false},{"type":"link","label":"Maintaining this site","href":"/spec-up-t-website/docs/this-site-maintainers","docId":"this-site-maintainers","unlisted":false},{"type":"link","label":"Glossary","href":"/spec-up-t-website/docs/glossary","docId":"glossary","unlisted":false},{"type":"link","label":"Troubleshooting","href":"/spec-up-t-website/docs/troubleshooting","docId":"troubleshooting","unlisted":false}]},"docs":{"glossary":{"id":"glossary","title":"Glossary","description":"This is a glossary with some terms that you need to know in order to understand working with Spec-Up-T.","sidebar":"tutorialSidebar"},"how-it-came-to-be":{"id":"how-it-came-to-be","title":"How it came to be","description":"The ToIP Terms extension of Spec-Up","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Introduction","description":"Intro","sidebar":"tutorialSidebar"},"q-and-a":{"id":"q-and-a","title":"Q & A","description":"Questions and answers about Spec-Up-T.","sidebar":"tutorialSidebar"},"spec-up-t-demo-site":{"id":"spec-up-t-demo-site","title":"Spec-Up-T demo","description":"The Demo","sidebar":"tutorialSidebar"},"this-site-maintainers":{"id":"this-site-maintainers","title":"Maintaining this site","description":"Here you will find information about things specific to this site.","sidebar":"tutorialSidebar"},"troubleshooting":{"id":"troubleshooting","title":"Troubleshooting","description":"Some tips in case of problems:","sidebar":"tutorialSidebar"},"various-roles/admins-guide":{"id":"various-roles/admins-guide","title":"Admins Guide","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/content-authors-guide/introduction":{"id":"various-roles/content-authors-guide/introduction","title":"Content Authors Guide","description":"Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.","sidebar":"tutorialSidebar"},"various-roles/curators-guide/introduction":{"id":"various-roles/curators-guide/introduction","title":"introduction","description":"---","sidebar":"tutorialSidebar"},"various-roles/developers-guide":{"id":"various-roles/developers-guide","title":"Developers Guide","description":"This page is the developer\'s guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/general-guide":{"id":"various-roles/general-guide","title":"General Guide","description":"These are general instructions for every role involved.","sidebar":"tutorialSidebar"},"various-roles/glossary-maintainers-guide/introduction":{"id":"various-roles/glossary-maintainers-guide/introduction","title":"Glossary Maintainers Guide","description":"Uses: Source management tool.","sidebar":"tutorialSidebar"},"various-roles/intro":{"id":"various-roles/intro","title":"Intro","description":"Spec-Up-T implementations can distinguish the following roles:","sidebar":"tutorialSidebar"},"various-roles/readers-guide/introduction":{"id":"various-roles/readers-guide/introduction","title":"Readers Guide","description":"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.","sidebar":"tutorialSidebar"},"various-roles/technical-skills-needed":{"id":"various-roles/technical-skills-needed","title":"Technical skills needed","description":"Spec-Up-T is a specialized tool designed to facilitate the creation, management, and rendering of technical specifications in a streamlined manner. Users who intend to leverage Spec-Up-T for their projects must possess a foundational level of technical knowledge to navigate the installation, configuration, and utilization of this tool effectively. This article delves into the technical prerequisites necessary for a user to operate Spec-Up-T competently.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/external-term-references":{"id":"various-roles/terminology-authors-guide/external-term-references","title":"External Term References","description":"It is possible to include references to terms from external spec-up generated specifications. To include a source you would like to pull references from include an external_specs array in your spec config. The value should be a key/value object where the key is used in the external reference below and the value is the URL of the external spec.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/introduction":{"id":"various-roles/terminology-authors-guide/introduction","title":"Terminology Authors Guide","description":"Focusses on term definitions covering concepts of the group he/she belongs to.","sidebar":"tutorialSidebar"},"various-roles/terminology-authors-guide/term-references":{"id":"various-roles/terminology-authors-guide/term-references","title":"Term References","description":"Definition Lists","sidebar":"tutorialSidebar"}}}}')}}]);
\ No newline at end of file
diff --git a/assets/js/main.c3d7ccc2.js b/assets/js/main.362bb374.js
similarity index 99%
rename from assets/js/main.c3d7ccc2.js
rename to assets/js/main.362bb374.js
index 7e4b8abf..7ff68bca 100644
--- a/assets/js/main.c3d7ccc2.js
+++ b/assets/js/main.362bb374.js
@@ -1,2 +1,2 @@
-/*! For license information please see main.c3d7ccc2.js.LICENSE.txt */
-(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8792],{5391:(e,t,n)=>{"use strict";function r(e){var t,n,o="";if("string"==typeof e||"number"==typeof e)o+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;tYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,s=i.length;-1!==n.code.indexOf(o=t(r,s));)++s;return i[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(s){for(var l=0;lYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const r=n(6969),o=n(8380),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(3157).resolve(t)],delete Prism.languages[e],n(3157)(t),a.add(e)}))}i.silent=!1,e.exports=i},9700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,s=i.length;-1!==n.code.indexOf(o=t(r,s));)++s;return i[s]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(s){for(var l=0;l