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:"create-or-edit-the-sample-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:"Create PDF",id:"create-pdf",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.jsx)(n.h2,{id:"start-command-line-menu",children:"Start command line menu"}),"\n",(0,i.jsxs)(n.p,{children:["Assuming you already ",(0,i.jsx)(n.a,{href:"admins-guide/#installation",children:"installed"})," Spec-Up-T, here you find further instructions:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npm run menu\n"})}),"\n",(0,i.jsx)(n.p,{children:"You will now see this menu:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:'Please choose one of the following options:\n\n [1] Render specification"\n [2] Export to PDF"\n [3] Look up xrefs"\n [4] Remove xref"\n [5] Validate config file"\n [6] Add new terms"\n [7] Open documentation website"\n [Q] Quit"\n'})}),"\n",(0,i.jsxs)(n.p,{children:["These are \u201cshortcuts\u201d to the commands covered later below (such as ",(0,i.jsx)(n.code,{children:"npm run render"}),", etc.). You can choose which you prefer: the menu or the direct commands."]}),"\n",(0,i.jsx)(n.h2,{id:"get-help",children:"Get help"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npm run help\n"})}),"\n",(0,i.jsx)(n.p,{children:"This command will show a URL to the documentation website (the website you are reading right now)."}),"\n",(0,i.jsxs)(n.h2,{id:"create-or-edit-the-sample-specjson",children:["Create (or edit the sample) ",(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:"create-pdf",children:"Create PDF"}),"\n",(0,i.jsxs)(n.p,{children:["If you want to create a PDF from the ",(0,i.jsx)(n.code,{children:"index.html"}),", run the following command:"]}),"\n",(0,i.jsx)(n.admonition,{type:"info",children:(0,i.jsx)(n.p,{children:"\u201ctopdf\u201d stands for \u201cTo PDF\u201d"})}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"npm run topdf\n"})}),"\n",(0,i.jsxs)(n.p,{children:["A PDF will be created in the same directory as the ",(0,i.jsx)(n.code,{children:"index.html"})," file is."]}),"\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/dff1e1e9.eef88261.js b/assets/js/dff1e1e9.eef88261.js
new file mode 100644
index 00000000..d24c054e
--- /dev/null
+++ b/assets/js/dff1e1e9.eef88261.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8838],{2234:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var s=i(4848),r=i(8453);const t={sidebar_position:1},o="General Guide",d={id:"various-roles/general-guide",title:"General Guide",description:"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:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Intro",permalink:"/spec-up-t-website/docs/various-roles/intro"},next:{title:"Admins Guide",permalink:"/spec-up-t-website/docs/category/admins-guide"}},c={},l=[{value:"Start command line menu",id:"start-command-line-menu",level:2},{value:"Option [1] Render specification",id:"option-1-render-specification",level:3},{value:"Option [2] Export to PDF",id:"option-2-export-to-pdf",level:3},{value:"Option [3] Look up xrefs",id:"option-3-look-up-xrefs",level:3},{value:"Option [4] Remove xref",id:"option-4-remove-xref",level:3},{value:"Option [5] Validate config file",id:"option-5-validate-config-file",level:3},{value:"Option [6] Add new terms",id:"option-6-add-new-terms",level:3},{value:"Option [7] Open documentation website",id:"option-7-open-documentation-website",level:3},{value:"Option [Q] Quit",id:"option-q-quit",level:3},{value:"Create (or edit the sample) spec.json",id:"create-or-edit-the-sample-specjson",level:2},{value:"A complete installation",id:"a-complete-installation",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",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",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.admonition,{type:"info",children:(0,s.jsx)(n.p,{children:"This is a temporary page; parts will be moved to other pages and assigned to the various roles."})}),"\n",(0,s.jsx)(n.h2,{id:"start-command-line-menu",children:"Start command line menu"}),"\n",(0,s.jsxs)(n.p,{children:["Assuming you already ",(0,s.jsx)(n.a,{href:"admins-guide/#installation",children:"installed"})," Spec-Up-T, here you find further instructions:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run menu\n"})}),"\n",(0,s.jsx)(n.p,{children:"You will now see this menu:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"Please choose one of the following options:\n\n [1] Render specification\n [2] Export to PDF\n [3] Look up xrefs\n [4] Remove xref\n [5] Validate config file\n [6] Add new terms\n [7] Open documentation website\n [Q] Quit\n"})}),"\n",(0,s.jsxs)(n.p,{children:["These menu options act as shortcuts to the commands covered below, such as ",(0,s.jsx)(n.code,{children:"npm run render"})," and others. You can choose between using the menu or entering the direct commands yourself."]}),"\n",(0,s.jsx)(n.h3,{id:"option-1-render-specification",children:"Option [1] Render specification"}),"\n",(0,s.jsx)(n.p,{children:"Direct 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:["Creates the specification which is an index.html, in the ",(0,s.jsx)(n.code,{children:"docs"})," directory, as specified in the ",(0,s.jsx)(n.code,{children:"specs.json"})," file."]}),"\n",(0,s.jsxs)(n.p,{children:["To view the ",(0,s.jsx)(n.code,{children:"index.html"})," file, you can:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["Open it via ",(0,s.jsx)(n.code,{children:"file:///"})," in your file manager or"]}),"\n",(0,s.jsx)(n.li,{children:"Access it via HTTP by placing it on a web server."}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The easiest way is to double-click the file in your file manager, which should open it in your browser."}),"\n",(0,s.jsxs)(n.p,{children:["By the way, there are ",(0,s.jsx)(n.strong,{children:"three"})," 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.strong,{children:(0,s.jsx)(n.code,{children:"npm run edit"})})}),(0,s.jsx)(n.td,{children:"Renders the site and watches for changes, re-rendering automatically when you save a file."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"npm run render"})})}),(0,s.jsx)(n.td,{children:"Renders the site once without watching for changes."})]}),(0,s.jsxs)(n.tr,{children:[(0,s.jsx)(n.td,{children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"npm run dev"})})}),(0,s.jsx)(n.td,{children:"Enables debugging features."})]})]})]}),"\n",(0,s.jsx)(n.h3,{id:"option-2-export-to-pdf",children:"Option [2] Export to PDF"}),"\n",(0,s.jsx)(n.p,{children:"Direct command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run topdf\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Creates a PDF. The PDF will be created in the same directory as the ",(0,s.jsx)(n.code,{children:"index.html"})," file."]}),"\n",(0,s.jsx)(n.h3,{id:"option-3-look-up-xrefs",children:"Option [3] Look up xrefs"}),"\n",(0,s.jsx)(n.p,{children:"Direct command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run xrefs\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"xrefs"})," are references to external glossaries (specifications). Each ",(0,s.jsx)(n.code,{children:"xref"})," is checked against a local data collection to see if a reference already exists, maintaining the original version of an external term."]}),"\n",(0,s.jsx)(n.h3,{id:"option-4-remove-xref",children:"Option [4] Remove xref"}),"\n",(0,s.jsx)(n.p,{children:"Direct command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:'npm run removexref -- "termValue" "externalSpecValue"\n'})}),"\n",(0,s.jsxs)(n.p,{children:["If you need to remove an ",(0,s.jsx)(n.code,{children:"xref"})," to update it to the current version of an external reference, use:"]}),"\n",(0,s.jsxs)(n.p,{children:["After removing the old reference, you can run ",(0,s.jsx)(n.code,{children:"npm run xrefs"})," again to get the latest reference."]}),"\n",(0,s.jsx)(n.h3,{id:"option-5-validate-config-file",children:"Option [5] Validate config file"}),"\n",(0,s.jsx)(n.p,{children:"Direct command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run validatespec\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Once you've edited the ",(0,s.jsx)(n.code,{children:"spec.json"}),", you can test it to check for missing keys. If a key is missing, you'll receive a notification."]}),"\n",(0,s.jsx)(n.h3,{id:"option-6-add-new-terms",children:"Option [6] Add new terms"}),"\n",(0,s.jsx)(n.p,{children:"Direct command:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npm run addterms\n"})}),"\n",(0,s.jsx)(n.p,{children:"If you create a new markdown file with a term and definition in it, it is not automatically included in the final product. Only if you want it can it be included in the index. With this command you add it to the index."}),"\n",(0,s.jsx)(n.h3,{id:"option-7-open-documentation-website",children:"Option [7] Open documentation website"}),"\n",(0,s.jsx)(n.p,{children:"No Direct command."}),"\n",(0,s.jsx)(n.p,{children:"This command will redirect to the documentation website (the site you are reading right now)."}),"\n",(0,s.jsx)(n.h3,{id:"option-q-quit",children:"Option [Q] Quit"}),"\n",(0,s.jsx)(n.p,{children:"This command will take you out of the menu."}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.strong,{children:"This is the end of the explanation of the menu."})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsxs)(n.h2,{id:"create-or-edit-the-sample-specjson",children:["Create (or edit the sample) ",(0,s.jsx)(n.code,{children:"spec.json"})]}),"\n",(0,s.jsxs)(n.p,{children:["The ",(0,s.jsx)(n.code,{children:"specs.json"})," file, located in the root folder of your repository, specifies the configuration values used in generating your specification documents. These values include the locations of your markdown files, the output path for the generated spec, and metadata like the title, logo, and repository links for each of your specs. Below are the required and optional fields supported in the ",(0,s.jsx)(n.code,{children:"specs.json"})," config file:"]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"public_root"})})," ",(0,s.jsx)(n.em,{children:"(PATH STRING, optional)"}),": Used to specify a path segment for platforms where the directory structure may differ between local and published environments."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"specs"})})," ",(0,s.jsx)(n.em,{children:"(ARRAY, required)"}),": Contains descriptor objects for each spec in your project, including properties like:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"spec_directory"})})," ",(0,s.jsx)(n.em,{children:"(STRING, required)"}),": The repo-root-relative location of your markdown file directory. The tool automatically searches for ",(0,s.jsx)(n.code,{children:"spec.md"})," here unless otherwise specified in the optional ",(0,s.jsx)(n.code,{children:"markdown_paths"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"title"})})," ",(0,s.jsx)(n.em,{children:"(STRING, required)"}),": The title for your spec, rendered in the document's H1 text and page title."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"logo"})})," ",(0,s.jsx)(n.em,{children:"(PATH/URI STRING, optional)"}),": A reference to a logo asset via a path or URI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"logo_link"})})," ",(0,s.jsx)(n.em,{children:"(URI STRING, optional)"}),": The URI your logo points to on the rendered page."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"markdown_paths"})})," ",(0,s.jsx)(n.em,{children:"(ARRAY, optional)"}),": Specifies alternative names for your markdown files or includes multiple files for assembly into a single document."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"katex"})})," ",(0,s.jsx)(n.em,{children:"(BOOLEAN, optional)"}),": Enables TeX support via KaTeX when set to ",(0,s.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"output_path"})})," ",(0,s.jsx)(n.em,{children:"(STRING, optional)"}),": Specifies an alternative output location for the generated spec document."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"source"})})," ",(0,s.jsx)(n.em,{children:"(OBJECT, optional)"}),": Configures the source of repo-specific data, such as the hosting service (",(0,s.jsx)(n.code,{children:"host"}),"), account/org (",(0,s.jsx)(n.code,{children:"account"}),"), and repository name (",(0,s.jsx)(n.code,{children:"repo"}),")."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"You're now ready to start rendering specs as HTML sites locally and/or pushing them to GitHub Pages."}),"\n",(0,s.jsx)(n.h2,{id:"a-complete-installation",children:"A complete installation"}),"\n",(0,s.jsx)(n.p,{children:"This is what a complete installation looks:"}),"\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.jsxs)(n.p,{children:["See ",(0,s.jsxs)(n.a,{href:"https://github.com/blockchainbird/spec-up-t-starter-pack/tree/main/spec-up-t-starterpack",children:["directory ",(0,s.jsx)(n.code,{children:"spec-up-t-starterpack"})," of the installer"]})]}),"\n",(0,s.jsx)(n.h2,{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/f049f840.64d0f3cc.js b/assets/js/f049f840.a56e48c8.js
similarity index 76%
rename from assets/js/f049f840.64d0f3cc.js
rename to assets/js/f049f840.a56e48c8.js
index 62fc0da0..8210e21e 100644
--- a/assets/js/f049f840.64d0f3cc.js
+++ b/assets/js/f049f840.a56e48c8.js
@@ -1 +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":"Cheat sheet","href":"/spec-up-t-website/docs/cheat-sheet","docId":"cheat-sheet","unlisted":false},{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"GitHub Token","href":"/spec-up-t-website/docs/github-token","docId":"github-token","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":"General Guide","href":"/spec-up-t-website/docs/various-roles/general-guide","docId":"various-roles/general-guide","unlisted":false},{"type":"category","label":"Admins Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","href":"/spec-up-t-website/docs/various-roles/admins-guide/","docId":"various-roles/admins-guide/admins-guide","unlisted":false},{"type":"link","label":"Updating","href":"/spec-up-t-website/docs/various-roles/admins-guide/updating","docId":"various-roles/admins-guide/updating","unlisted":false},{"type":"link","label":"Extra Tools","href":"/spec-up-t-website/docs/various-roles/admins-guide/tools","docId":"various-roles/admins-guide/tools","unlisted":false}],"href":"/spec-up-t-website/docs/category/admins-guide"},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","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":"Intro","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":"Intro","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":"Intro","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":"Intro","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},{"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}],"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":{"cheat-sheet":{"id":"cheat-sheet","title":"Cheat sheet","description":"This cheat sheet still needs to be completed. Information on how to write content, create references, and more will be added in the future.","sidebar":"tutorialSidebar"},"github-token":{"id":"github-token","title":"GitHub Token","description":"Intro","sidebar":"tutorialSidebar"},"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/admins-guide":{"id":"various-roles/admins-guide/admins-guide","title":"Intro","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/admins-guide/tools":{"id":"various-roles/admins-guide/tools","title":"Extra Tools","description":"Splitter Tool","sidebar":"tutorialSidebar"},"various-roles/admins-guide/updating":{"id":"various-roles/admins-guide/updating","title":"Updating","description":"Updating Spec-Up-T means two things:","sidebar":"tutorialSidebar"},"various-roles/content-authors-guide/introduction":{"id":"various-roles/content-authors-guide/introduction","title":"Intro","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/curators-guide/introduction":{"id":"various-roles/curators-guide/introduction","title":"Intro","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":"Intro","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":"Intro","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":"Intro","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
+"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":"Cheat sheet","href":"/spec-up-t-website/docs/cheat-sheet","docId":"cheat-sheet","unlisted":false},{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"GitHub Token","href":"/spec-up-t-website/docs/github-token","docId":"github-token","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":"General Guide","href":"/spec-up-t-website/docs/various-roles/general-guide","docId":"various-roles/general-guide","unlisted":false},{"type":"category","label":"Admins Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","href":"/spec-up-t-website/docs/various-roles/admins-guide/","docId":"various-roles/admins-guide/admins-guide","unlisted":false},{"type":"link","label":"Updating","href":"/spec-up-t-website/docs/various-roles/admins-guide/updating","docId":"various-roles/admins-guide/updating","unlisted":false},{"type":"link","label":"Extra Tools","href":"/spec-up-t-website/docs/various-roles/admins-guide/tools","docId":"various-roles/admins-guide/tools","unlisted":false}],"href":"/spec-up-t-website/docs/category/admins-guide"},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Intro","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":"Intro","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":"Intro","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":"Intro","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":"Intro","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},{"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}],"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":{"cheat-sheet":{"id":"cheat-sheet","title":"Cheat sheet","description":"This cheat sheet still needs to be completed. Information on how to write content, create references, and more will be added in the future.","sidebar":"tutorialSidebar"},"github-token":{"id":"github-token","title":"GitHub Token","description":"Intro","sidebar":"tutorialSidebar"},"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/admins-guide":{"id":"various-roles/admins-guide/admins-guide","title":"Intro","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"various-roles/admins-guide/tools":{"id":"various-roles/admins-guide/tools","title":"Extra Tools","description":"Splitter Tool","sidebar":"tutorialSidebar"},"various-roles/admins-guide/updating":{"id":"various-roles/admins-guide/updating","title":"Updating","description":"Updating Spec-Up-T means two things:","sidebar":"tutorialSidebar"},"various-roles/content-authors-guide/introduction":{"id":"various-roles/content-authors-guide/introduction","title":"Intro","description":"Under construction","sidebar":"tutorialSidebar"},"various-roles/curators-guide/introduction":{"id":"various-roles/curators-guide/introduction","title":"Intro","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":"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":"Intro","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":"Intro","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":"Intro","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/main.3d915988.js b/assets/js/main.31cfefc3.js
similarity index 99%
rename from assets/js/main.3d915988.js
rename to assets/js/main.31cfefc3.js
index a71d1fe4..3dde6f3b 100644
--- a/assets/js/main.3d915988.js
+++ b/assets/js/main.31cfefc3.js
@@ -1,2 +1,2 @@
-/*! For license information please see main.3d915988.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