From b349ae06a78dbfb0f649ecd4cabaa89604580e6e Mon Sep 17 00:00:00 2001 From: kordwarshuis Date: Tue, 2 Jul 2024 11:33:35 +0000 Subject: [PATCH] deploy: 7ee1b776761ed348abf2edb26ae996919bc6bf79 --- 404.html | 2 +- assets/js/0e384e19.20e74a75.js | 1 - assets/js/0e384e19.f387dee3.js | 1 + ...n.704ad5b9.js => runtime~main.1deffdc2.js} | 2 +- blog/archive/index.html | 2 +- blog/index.html | 2 +- blog/tags/index.html | 2 +- blog/tags/keri/index.html | 2 +- blog/tags/ssi/index.html | 2 +- blog/tags/toip/index.html | 2 +- blog/welcome/index.html | 2 +- docs/category/guide/index.html | 2 +- docs/category/short-history/index.html | 2 +- .../guide/external-term-references/index.html | 2 +- docs/guide/term-references/index.html | 2 +- docs/intro/index.html | 25 ++++++++++++++----- .../spec-up-and-spec-up-t/index.html | 2 +- index.html | 2 +- markdown-page/index.html | 2 +- 19 files changed, 36 insertions(+), 23 deletions(-) delete mode 100644 assets/js/0e384e19.20e74a75.js create mode 100644 assets/js/0e384e19.f387dee3.js rename assets/js/{runtime~main.704ad5b9.js => runtime~main.1deffdc2.js} (98%) diff --git a/404.html b/404.html index 88f4c874..c424de20 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | Spec-Up-T - + diff --git a/assets/js/0e384e19.20e74a75.js b/assets/js/0e384e19.20e74a75.js deleted file mode 100644 index fe336a3a..00000000 --- a/assets/js/0e384e19.20e74a75.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[976],{619:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>a,frontMatter:()=>i,metadata:()=>d,toc:()=>c});var s=r(4848),t=r(8453);const i={sidebar_position:1},o="Tutorial Intro",d={id:"intro",title:"Tutorial Intro",description:"Let's discover Spec-Up-T in less than 5 minutes.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/spec-up-t-website/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Guide",permalink:"/spec-up-t-website/docs/category/guide"}},l={},c=[{value:"Getting Started",id:"getting-started",level:2},{value:"What you'll need",id:"what-youll-need",level:3},{value:"Generate a new site",id:"generate-a-new-site",level:2},{value:"Running the scripts locally",id:"running-the-scripts-locally",level:2},{value:"Automation",id:"automation",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2}];function h(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h1,{id:"tutorial-intro",children:"Tutorial Intro"}),"\n",(0,s.jsxs)(n.p,{children:["Let's discover ",(0,s.jsx)(n.strong,{children:"Spec-Up-T in less than 5 minutes"}),"."]}),"\n",(0,s.jsx)("video",{src:r(6525).A,controls:!0,muted:!0,autoplay:!0,loop:!0}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,s.jsxs)(n.p,{children:["Get started by ",(0,s.jsx)(n.strong,{children:"creating a new site"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"what-youll-need",children:"What you'll need"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"https://nodejs.org/en/download/",children:"Node.js"}),":","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When installing Node.js, you are recommended to check all checkboxes related to dependencies."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"generate-a-new-site",children:"Generate a new site"}),"\n",(0,s.jsx)(n.p,{children:"Generate a new Spec-Up-T site."}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.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,s.jsx)(n.p,{children:"You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor."}),"\n",(0,s.jsxs)(n.p,{children:["This will create a working Spec-Up-T installation in a new directory called ",(0,s.jsx)(n.code,{children:"my-spec-up-t-website"})]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Go into this dir:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd my-spec-up-t-website\n"})}),"\n",(0,s.jsx)(n.p,{children:"You are now in this dir."}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Install all dependencies:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"npm run install\n"})}),"\n",(0,s.jsx)(n.p,{children:"Look up xrefs:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"npm run xrefs\n"})}),"\n",(0,s.jsx)(n.p,{children:"Now the references to external specs are generated."}),"\n",(0,s.jsx)(n.p,{children:"Create index.html:"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{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.p,{children:"Now you have a basic Spec-Up-T install 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 a sample markdown files"]}),"\n",(0,s.jsx)(n.li,{children:"(and more)"}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The",(0,s.jsx)(n.code,{children:"specs.json"})," file ",(0,s.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,s.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,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)"})," - 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,s.jsx)(n.code,{children:"public_root"})," property to specify the insertion of a path segment to account for the different in pathing between your local renders and wherever you publish your spec to."]}),"\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)"})," - the ",(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"spec_directory"})})," ",(0,s.jsx)(n.em,{children:"(STRING, required)"})," - You must specify the ",(0,s.jsx)(n.strong,{children:"repo-root-relative"})," location of your spec's markdown file directory. You ",(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.strong,{children:"MUST"})})," name your spec's markdown file ",(0,s.jsx)(n.code,{children:"spec.md"})," and locate it in your ",(0,s.jsx)(n.code,{children:"spec_directory"})," for the tool to 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,s.jsx)(n.code,{children:"markdown_paths"}),' field described below. See the "multi-file" example in the spec-up repo.']}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"title"})})," ",(0,s.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"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"logo"})})," ",(0,s.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"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{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 you want your logo to point to in the rendered page."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"markdown_paths"})})," ",(0,s.jsx)(n.em,{children:"(ARRAY, optional)"})," - If you want to name your spec's markdown file something other than ",(0,s.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,s.jsx)(n.code,{children:"spec_directory"})," you specified, so ",(0,s.jsx)(n.em,{children:"DO NOT"})," repeat the full root relative path."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"katex"})})," ",(0,s.jsx)(n.em,{children:"(BOOLEAN, optional)"})," - To enable TeX support via KaTeX, set this property to ",(0,s.jsx)(n.code,{children:"true"}),". After rendering, be sure to copy the ",(0,s.jsx)(n.code,{children:"fonts/"})," subdirectory, containing the necessary web fonts."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"output_path"})})," ",(0,s.jsx)(n.em,{children:"(STRING, optional)"})," - If you want the generated spec document to be output to a different location than the ",(0,s.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,s.jsx)(n.code,{children:"./"})," for root), and the tool will write the document file there instead."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"source"})})," ",(0,s.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,s.jsx)(n.code,{children:"host"})," (currently Spec-Up only supports ",(0,s.jsx)(n.code,{children:'"github"'}),", but this is extensible), add the account/org the repo is located within via the ",(0,s.jsx)(n.code,{children:"account"})," property, and add the repo name under the ",(0,s.jsx)(n.code,{children:"repo"})," property. Here is an example configuration:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "host": "github",\n "account": "decentralized-identity",\n "repo": "sidetree"\n}\n'})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h2,{id:"running-the-scripts-locally",children:"Running the scripts locally"}),"\n",(0,s.jsxs)(n.p,{children:["If your ",(0,s.jsx)(n.code,{children:"spec.json"})," and ",(0,s.jsx)(n.code,{children:"package.json"})," and ",(0,s.jsx)(n.code,{children:"package-lock.json"})," files are in working order and in the root folder of the repo from which it will be deployed, Spec-up can be called by command line (from the root of your repo) in three different modes:"]}),"\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.h2,{id:"automation",children:"Automation"}),"\n",(0,s.jsxs)(n.p,{children:["The above scripts can easily be triggered by 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"})]}),"\n",(0,s.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["WSL2 users are recommended to use the ",(0,s.jsx)(n.code,{children:"bash"})," option rather than ",(0,s.jsx)(n.code,{children:"PowerShell"})," in the terminal of Visual Studio Code."]}),"\n",(0,s.jsx)(n.li,{children:"Some users have reported problems using spec-up with node versions 15+; to pin to an older version, simple run:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"nvm install 14\nnvm use 14\nnpm i npm@6.14.16 -g\n"})})]})}function a(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},6525:(e,n,r)=>{r.d(n,{A:()=>s});const s=r.p+"assets/medias/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},8453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>d});var s=r(6540);const t={},i=s.createContext(t);function o(e){const n=s.useContext(i);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(t):e.components||t:o(e.components),s.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0e384e19.f387dee3.js b/assets/js/0e384e19.f387dee3.js new file mode 100644 index 00000000..ba9cb7d2 --- /dev/null +++ b/assets/js/0e384e19.f387dee3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[976],{619:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>o,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>c});var s=i(4848),r=i(8453);const t={sidebar_position:1},o="Tutorial Intro",d={id:"intro",title:"Tutorial Intro",description:"Let's discover Spec-Up-T in less than 5 minutes.",source:"@site/docs/intro.md",sourceDirName:".",slug:"/intro",permalink:"/spec-up-t-website/docs/intro",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/intro.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",next:{title:"Guide",permalink:"/spec-up-t-website/docs/category/guide"}},l={},c=[{value:"Getting Started",id:"getting-started",level:2},{value:"What you'll need",id:"what-youll-need",level:3},{value:"Generate a new site",id:"generate-a-new-site",level:2},{value:"Generate a new Spec-Up-T site",id:"generate-a-new-spec-up-t-site",level:3},{value:"Go into this dir",id:"go-into-this-dir",level:3},{value:"Install all dependencies",id:"install-all-dependencies",level:3},{value:"Look up xrefs",id:"look-up-xrefs",level:3},{value:"Create index.html",id:"create-indexhtml",level:3},{value:"You are ready",id:"you-are-ready",level:3},{value:"Running the scripts locally",id:"running-the-scripts-locally",level:2},{value:"Automation",id:"automation",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2}];function a(e){const n={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",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:"tutorial-intro",children:"Tutorial Intro"}),"\n",(0,s.jsxs)(n.p,{children:["Let's discover ",(0,s.jsx)(n.strong,{children:"Spec-Up-T in less than 5 minutes"}),"."]}),"\n",(0,s.jsx)("video",{src:i(6525).A,controls:!0,muted:!0,autoplay:!0,loop:!0}),"\n",(0,s.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,s.jsxs)(n.p,{children:["Get started by ",(0,s.jsx)(n.strong,{children:"creating a new site"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"what-youll-need",children:"What you'll need"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"https://nodejs.org/en/download/",children:"Node.js"}),":","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"When installing Node.js, you are recommended to check all checkboxes related to dependencies."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"generate-a-new-site",children:"Generate a new site"}),"\n",(0,s.jsx)(n.h3,{id:"generate-a-new-spec-up-t-site",children:"Generate a new Spec-Up-T site"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.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,s.jsx)(n.p,{children:"You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor."}),"\n",(0,s.jsxs)(n.p,{children:["This will create a working Spec-Up-T installation in a new directory called ",(0,s.jsx)(n.code,{children:"my-spec-up-t-website"})]}),"\n",(0,s.jsxs)(n.p,{children:["You should now have a directory called ",(0,s.jsx)(n.code,{children:"my-spec-up-t-website"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"go-into-this-dir",children:"Go into this dir"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Go into this dir:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-bash",children:"cd my-spec-up-t-website\n"})}),"\n",(0,s.jsx)(n.p,{children:"You are now in this dir."}),"\n",(0,s.jsx)(n.h3,{id:"install-all-dependencies",children:"Install all dependencies"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Install all dependencies:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"npm run install\n"})}),"\n",(0,s.jsx)(n.p,{children:"It can take some time, and you should see multiple lines of output during installation."}),"\n",(0,s.jsxs)(n.p,{children:["When the prompt is visible again, you should now have a directory called ",(0,s.jsx)(n.code,{children:"node_modules"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"look-up-xrefs",children:"Look up xrefs"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Look up xrefs:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{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.h3,{id:"create-indexhtml",children:"Create index.html"}),"\n",(0,s.jsxs)(n.p,{children:["The final result should be just one file: ",(0,s.jsx)(n.code,{children:"index.html"}),"."]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Create index.html:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{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.h3,{id:"you-are-ready",children:"You are ready"}),"\n",(0,s.jsx)(n.p,{children:"Now you have a basic Spec-Up-T install 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 a sample markdown files"]}),"\n",(0,s.jsx)(n.li,{children:"(and more)"}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["The",(0,s.jsx)(n.code,{children:"specs.json"})," file ",(0,s.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,s.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,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)"})," - 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,s.jsx)(n.code,{children:"public_root"})," property to specify the insertion of a path segment to account for the different in pathing between your local renders and wherever you publish your spec to."]}),"\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)"})," - the ",(0,s.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,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"spec_directory"})})," ",(0,s.jsx)(n.em,{children:"(STRING, required)"})," - You must specify the ",(0,s.jsx)(n.strong,{children:"repo-root-relative"})," location of your spec's markdown file directory. You ",(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.strong,{children:"MUST"})})," name your spec's markdown file ",(0,s.jsx)(n.code,{children:"spec.md"})," and locate it in your ",(0,s.jsx)(n.code,{children:"spec_directory"})," for the tool to 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,s.jsx)(n.code,{children:"markdown_paths"}),' field described below. See the "multi-file" example in the spec-up repo.']}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"title"})})," ",(0,s.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"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"logo"})})," ",(0,s.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"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{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 you want your logo to point to in the rendered page."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"markdown_paths"})})," ",(0,s.jsx)(n.em,{children:"(ARRAY, optional)"})," - If you want to name your spec's markdown file something other than ",(0,s.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,s.jsx)(n.code,{children:"spec_directory"})," you specified, so ",(0,s.jsx)(n.em,{children:"DO NOT"})," repeat the full root relative path."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"katex"})})," ",(0,s.jsx)(n.em,{children:"(BOOLEAN, optional)"})," - To enable TeX support via KaTeX, set this property to ",(0,s.jsx)(n.code,{children:"true"}),". After rendering, be sure to copy the ",(0,s.jsx)(n.code,{children:"fonts/"})," subdirectory, containing the necessary web fonts."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"output_path"})})," ",(0,s.jsx)(n.em,{children:"(STRING, optional)"})," - If you want the generated spec document to be output to a different location than the ",(0,s.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,s.jsx)(n.code,{children:"./"})," for root), and the tool will write the document file there instead."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"source"})})," ",(0,s.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,s.jsx)(n.code,{children:"host"})," (currently Spec-Up only supports ",(0,s.jsx)(n.code,{children:'"github"'}),", but this is extensible), add the account/org the repo is located within via the ",(0,s.jsx)(n.code,{children:"account"})," property, and add the repo name under the ",(0,s.jsx)(n.code,{children:"repo"})," property. Here is an example configuration:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:'{\n "host": "github",\n "account": "decentralized-identity",\n "repo": "sidetree"\n}\n'})}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.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,s.jsx)(n.h2,{id:"running-the-scripts-locally",children:"Running the scripts locally"}),"\n",(0,s.jsxs)(n.p,{children:["If your ",(0,s.jsx)(n.code,{children:"spec.json"})," and ",(0,s.jsx)(n.code,{children:"package.json"})," and ",(0,s.jsx)(n.code,{children:"package-lock.json"})," files are in working order and in the root folder of the repo from which it will be deployed, Spec-up can be called by command line (from the root of your repo) in three different modes:"]}),"\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.h2,{id:"automation",children:"Automation"}),"\n",(0,s.jsxs)(n.p,{children:["The above scripts can easily be triggered by 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"})]}),"\n",(0,s.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["WSL2 users are recommended to use the ",(0,s.jsx)(n.code,{children:"bash"})," option rather than ",(0,s.jsx)(n.code,{children:"PowerShell"})," in the terminal of Visual Studio Code."]}),"\n",(0,s.jsx)(n.li,{children:"Some users have reported problems using spec-up with node versions 15+; to pin to an older version, simple run:"}),"\n"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{children:"nvm install 14\nnvm use 14\nnpm i npm@6.14.16 -g\n"})})]})}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)}},6525:(e,n,i)=>{i.d(n,{A:()=>s});const s=i.p+"assets/medias/installer-spec-up-t-392cc74350811a36e6a9f89b426fa51b.mp4"},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/runtime~main.704ad5b9.js b/assets/js/runtime~main.1deffdc2.js similarity index 98% rename from assets/js/runtime~main.704ad5b9.js rename to assets/js/runtime~main.1deffdc2.js index 5e09b699..0386a030 100644 --- a/assets/js/runtime~main.704ad5b9.js +++ b/assets/js/runtime~main.1deffdc2.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,o,f={},c={};function n(e){var a=c[e];if(void 0!==a)return a.exports;var t=c[e]={id:e,loaded:!1,exports:{}};return f[e].call(t.exports,t,t.exports,n),t.loaded=!0,t.exports}n.m=f,n.c=c,e=[],n.O=(a,t,r,o)=>{if(!t){var f=1/0;for(i=0;i=o)&&Object.keys(n.O).every((e=>n.O[e](t[d])))?t.splice(d--,1):(c=!1,o0&&e[i-1][2]>o;i--)e[i]=e[i-1];e[i]=[t,r,o]},n.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return n.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);n.r(o);var f={};a=a||[null,t({}),t([]),t(t)];for(var c=2&r&&e;"object"==typeof c&&!~a.indexOf(c);c=t(c))Object.getOwnPropertyNames(c).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,n.d(o,f),o},n.d=(e,a)=>{for(var t in a)n.o(a,t)&&!n.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce(((a,t)=>(n.f[t](e,a),a)),[])),n.u=e=>"assets/js/"+({48:"a94703ab",52:"e193faee",61:"1f391b9e",89:"68f866db",98:"a7bd4aaa",134:"393be207",197:"009937db",202:"5218d425",209:"01a85c17",216:"f5be85ae",235:"a7456010",249:"ccc49370",292:"121b3df4",401:"17896441",418:"f049f840",422:"738e0f00",424:"67c1e926",426:"21283777",449:"fdea42e3",472:"814f3328",634:"c4f5d8e4",643:"a6aa9e1f",647:"5e95c892",685:"acc96f77",711:"9e4087bc",742:"aba21aa0",798:"b092bf9e",813:"6875c492",858:"36994c47",865:"166ee7c9",903:"acecf23e",969:"14eb3368",976:"0e384e19"}[e]||e)+"."+{48:"bbf09f2c",52:"b23fc474",61:"bea182c1",89:"3e98d9a1",98:"e61c3b7b",134:"6a78c15a",197:"2baa11b9",202:"b57e1bd5",209:"4a9fa1cc",216:"fa527582",235:"d27e4924",237:"f4fbea9d",242:"9d3241ed",249:"d57b6f79",292:"ec67301f",401:"bf145003",418:"00a66482",422:"f077e168",424:"ffe9b85c",426:"7d466021",449:"964ac8b1",472:"d1eea19c",538:"491379d9",634:"4d28cfb4",643:"42099b99",647:"7afa0510",685:"c978fb38",711:"d3f8ed7f",742:"bddde0da",798:"7209491c",813:"2ed1587b",858:"f2ddbf25",865:"859e5059",903:"d383a297",969:"c0626e6f",976:"20e74a75"}[e]+".js",n.miniCssF=e=>{},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},o="my-website:",n.l=(e,a,t,f)=>{if(r[e])r[e].push(a);else{var c,d;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{c.onerror=c.onload=null,clearTimeout(s);var o=r[e];if(delete r[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=l.bind(null,c.onerror),c.onload=l.bind(null,c.onload),d&&document.head.appendChild(c)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/spec-up-t-website/",n.gca=function(e){return e={17896441:"401",21283777:"426",a94703ab:"48",e193faee:"52","1f391b9e":"61","68f866db":"89",a7bd4aaa:"98","393be207":"134","009937db":"197","5218d425":"202","01a85c17":"209",f5be85ae:"216",a7456010:"235",ccc49370:"249","121b3df4":"292",f049f840:"418","738e0f00":"422","67c1e926":"424",fdea42e3:"449","814f3328":"472",c4f5d8e4:"634",a6aa9e1f:"643","5e95c892":"647",acc96f77:"685","9e4087bc":"711",aba21aa0:"742",b092bf9e:"798","6875c492":"813","36994c47":"858","166ee7c9":"865",acecf23e:"903","14eb3368":"969","0e384e19":"976"}[e]||e,n.p+n.u(e)},(()=>{var e={354:0,869:0};n.f.j=(a,t)=>{var r=n.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(354|869)$/.test(a))e[a]=0;else{var o=new Promise(((t,o)=>r=e[a]=[t,o]));t.push(r[2]=o);var f=n.p+n.u(a),c=new Error;n.l(f,(t=>{if(n.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var o=t&&("load"===t.type?"missing":t.type),f=t&&t.target&&t.target.src;c.message="Loading chunk "+a+" failed.\n("+o+": "+f+")",c.name="ChunkLoadError",c.type=o,c.request=f,r[1](c)}}),"chunk-"+a,a)}},n.O.j=a=>0===e[a];var a=(a,t)=>{var r,o,f=t[0],c=t[1],d=t[2],b=0;if(f.some((a=>0!==e[a]))){for(r in c)n.o(c,r)&&(n.m[r]=c[r]);if(d)var i=d(n)}for(a&&a(t);b{"use strict";var e,a,t,r,o,f={},c={};function n(e){var a=c[e];if(void 0!==a)return a.exports;var t=c[e]={id:e,loaded:!1,exports:{}};return f[e].call(t.exports,t,t.exports,n),t.loaded=!0,t.exports}n.m=f,n.c=c,e=[],n.O=(a,t,r,o)=>{if(!t){var f=1/0;for(i=0;i=o)&&Object.keys(n.O).every((e=>n.O[e](t[d])))?t.splice(d--,1):(c=!1,o0&&e[i-1][2]>o;i--)e[i]=e[i-1];e[i]=[t,r,o]},n.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return n.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,n.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var o=Object.create(null);n.r(o);var f={};a=a||[null,t({}),t([]),t(t)];for(var c=2&r&&e;"object"==typeof c&&!~a.indexOf(c);c=t(c))Object.getOwnPropertyNames(c).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,n.d(o,f),o},n.d=(e,a)=>{for(var t in a)n.o(a,t)&&!n.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},n.f={},n.e=e=>Promise.all(Object.keys(n.f).reduce(((a,t)=>(n.f[t](e,a),a)),[])),n.u=e=>"assets/js/"+({48:"a94703ab",52:"e193faee",61:"1f391b9e",89:"68f866db",98:"a7bd4aaa",134:"393be207",197:"009937db",202:"5218d425",209:"01a85c17",216:"f5be85ae",235:"a7456010",249:"ccc49370",292:"121b3df4",401:"17896441",418:"f049f840",422:"738e0f00",424:"67c1e926",426:"21283777",449:"fdea42e3",472:"814f3328",634:"c4f5d8e4",643:"a6aa9e1f",647:"5e95c892",685:"acc96f77",711:"9e4087bc",742:"aba21aa0",798:"b092bf9e",813:"6875c492",858:"36994c47",865:"166ee7c9",903:"acecf23e",969:"14eb3368",976:"0e384e19"}[e]||e)+"."+{48:"bbf09f2c",52:"b23fc474",61:"bea182c1",89:"3e98d9a1",98:"e61c3b7b",134:"6a78c15a",197:"2baa11b9",202:"b57e1bd5",209:"4a9fa1cc",216:"fa527582",235:"d27e4924",237:"f4fbea9d",242:"9d3241ed",249:"d57b6f79",292:"ec67301f",401:"bf145003",418:"00a66482",422:"f077e168",424:"ffe9b85c",426:"7d466021",449:"964ac8b1",472:"d1eea19c",538:"491379d9",634:"4d28cfb4",643:"42099b99",647:"7afa0510",685:"c978fb38",711:"d3f8ed7f",742:"bddde0da",798:"7209491c",813:"2ed1587b",858:"f2ddbf25",865:"859e5059",903:"d383a297",969:"c0626e6f",976:"f387dee3"}[e]+".js",n.miniCssF=e=>{},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),n.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},o="my-website:",n.l=(e,a,t,f)=>{if(r[e])r[e].push(a);else{var c,d;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{c.onerror=c.onload=null,clearTimeout(s);var o=r[e];if(delete r[e],c.parentNode&&c.parentNode.removeChild(c),o&&o.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=l.bind(null,c.onerror),c.onload=l.bind(null,c.onload),d&&document.head.appendChild(c)}},n.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.p="/spec-up-t-website/",n.gca=function(e){return e={17896441:"401",21283777:"426",a94703ab:"48",e193faee:"52","1f391b9e":"61","68f866db":"89",a7bd4aaa:"98","393be207":"134","009937db":"197","5218d425":"202","01a85c17":"209",f5be85ae:"216",a7456010:"235",ccc49370:"249","121b3df4":"292",f049f840:"418","738e0f00":"422","67c1e926":"424",fdea42e3:"449","814f3328":"472",c4f5d8e4:"634",a6aa9e1f:"643","5e95c892":"647",acc96f77:"685","9e4087bc":"711",aba21aa0:"742",b092bf9e:"798","6875c492":"813","36994c47":"858","166ee7c9":"865",acecf23e:"903","14eb3368":"969","0e384e19":"976"}[e]||e,n.p+n.u(e)},(()=>{var e={354:0,869:0};n.f.j=(a,t)=>{var r=n.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(354|869)$/.test(a))e[a]=0;else{var o=new Promise(((t,o)=>r=e[a]=[t,o]));t.push(r[2]=o);var f=n.p+n.u(a),c=new Error;n.l(f,(t=>{if(n.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var o=t&&("load"===t.type?"missing":t.type),f=t&&t.target&&t.target.src;c.message="Loading chunk "+a+" failed.\n("+o+": "+f+")",c.name="ChunkLoadError",c.type=o,c.request=f,r[1](c)}}),"chunk-"+a,a)}},n.O.j=a=>0===e[a];var a=(a,t)=>{var r,o,f=t[0],c=t[1],d=t[2],b=0;if(f.some((a=>0!==e[a]))){for(r in c)n.o(c,r)&&(n.m[r]=c[r]);if(d)var i=d(n)}for(a&&a(t);b Archive | Spec-Up-T - + diff --git a/blog/index.html b/blog/index.html index 20445ce0..cfb74ddb 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | Spec-Up-T - + diff --git a/blog/tags/index.html b/blog/tags/index.html index 0d5f07d2..152f0d1d 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,7 +5,7 @@ Tags | Spec-Up-T - + diff --git a/blog/tags/keri/index.html b/blog/tags/keri/index.html index f23cf29c..5defaa05 100644 --- a/blog/tags/keri/index.html +++ b/blog/tags/keri/index.html @@ -5,7 +5,7 @@ One post tagged with "keri" | Spec-Up-T - + diff --git a/blog/tags/ssi/index.html b/blog/tags/ssi/index.html index cfef5620..39e725ca 100644 --- a/blog/tags/ssi/index.html +++ b/blog/tags/ssi/index.html @@ -5,7 +5,7 @@ One post tagged with "ssi" | Spec-Up-T - + diff --git a/blog/tags/toip/index.html b/blog/tags/toip/index.html index 84b7c54f..3fdc4735 100644 --- a/blog/tags/toip/index.html +++ b/blog/tags/toip/index.html @@ -5,7 +5,7 @@ One post tagged with "toip" | Spec-Up-T - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index 5349fca8..5b84d436 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | Spec-Up-T - + diff --git a/docs/category/guide/index.html b/docs/category/guide/index.html index 7297222d..2928f703 100644 --- a/docs/category/guide/index.html +++ b/docs/category/guide/index.html @@ -5,7 +5,7 @@ Guide | Spec-Up-T - + diff --git a/docs/category/short-history/index.html b/docs/category/short-history/index.html index ca113487..a6db6dd1 100644 --- a/docs/category/short-history/index.html +++ b/docs/category/short-history/index.html @@ -5,7 +5,7 @@ Short History | Spec-Up-T - + diff --git a/docs/guide/external-term-references/index.html b/docs/guide/external-term-references/index.html index f1954b6e..5755ed82 100644 --- a/docs/guide/external-term-references/index.html +++ b/docs/guide/external-term-references/index.html @@ -5,7 +5,7 @@ External Term References | Spec-Up-T - + diff --git a/docs/guide/term-references/index.html b/docs/guide/term-references/index.html index 8d07cd2c..98122372 100644 --- a/docs/guide/term-references/index.html +++ b/docs/guide/term-references/index.html @@ -5,7 +5,7 @@ Term References | Spec-Up-T - + diff --git a/docs/intro/index.html b/docs/intro/index.html index 11825020..b8da3778 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,7 +5,7 @@ Tutorial Intro | Spec-Up-T - + @@ -23,26 +23,39 @@

What you

Generate a new site​

-

Generate a new Spec-Up-T site.

+

Generate a new Spec-Up-T site​

npx create-spec-up-t my-spec-up-t-website

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).

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

This will create a working Spec-Up-T installation in a new directory called my-spec-up-t-website

+

You should now have a directory called my-spec-up-t-website.

+

Go into this dir​

  • Go into this dir:
cd my-spec-up-t-website

You are now in this dir.

+

Install all dependencies​

  • Install all dependencies:
npm run install
-

Look up xrefs:

+

It can take some time, and you should see multiple lines of output during installation.

+

When the prompt is visible again, you should now have a directory called node_modules.

+

Look up xrefs​

+
    +
  • Look up xrefs:
    • +
npm run xrefs
-

Now the references to external specs are generated.

-

Create index.html:

+

Now the references to external specs are generated, if any.

+

Create index.html​

+

The final result should be just one file: index.html.

+
    +
  • Create index.html:
    • +
npm run render

Now an index.html file is created in the docs directory. This is the default directory, specified in the specs.json file.

+

You are ready​

Now you have a basic Spec-Up-T install with the following content:

  • a specs.json file
    • @@ -93,6 +106,6 @@

    Troubleshoot
  • WSL2 users are recommended to use the bash option rather than PowerShell in the terminal of Visual Studio Code.
  • Some users have reported problems using spec-up with node versions 15+; to pin to an older version, simple run:

-
nvm install 14
nvm use 14
npm i npm@6.14.16 -g
+
nvm install 14
nvm use 14
npm i npm@6.14.16 -g
\ No newline at end of file diff --git a/docs/short-history/spec-up-and-spec-up-t/index.html b/docs/short-history/spec-up-and-spec-up-t/index.html index 6df3332b..94022743 100644 --- a/docs/short-history/spec-up-and-spec-up-t/index.html +++ b/docs/short-history/spec-up-and-spec-up-t/index.html @@ -5,7 +5,7 @@ Spec-Up and Spec-Up-T | Spec-Up-T - + diff --git a/index.html b/index.html index abf4b96c..e92fc95e 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from Spec-Up-T | Spec-Up-T - + diff --git a/markdown-page/index.html b/markdown-page/index.html index d64a5fe7..df5c8f47 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | Spec-Up-T - +