From 42b2b3550e16b22bff4edf0b6c48e569499c9820 Mon Sep 17 00:00:00 2001 From: kordwarshuis Date: Sun, 18 Aug 2024 17:34:19 +0000 Subject: [PATCH] deploy: 7366340eb2f18de7a0b59a65a6cfe46bbe59be38 --- 404.html | 2 +- assets/js/2be7da73.128b5fd3.js | 1 + assets/js/2be7da73.6c27dffc.js | 1 - assets/js/3dc49084.3c6f0e3f.js | 1 + assets/js/3dc49084.8790a5ee.js | 1 - assets/js/8050fd0a.0a99c9ed.js | 1 + assets/js/8050fd0a.6ee49d6c.js | 1 - assets/js/9428579a.41526df7.js | 1 - assets/js/9428579a.c8401bd0.js | 1 + assets/js/c4a0550b.6aa12fab.js | 1 - assets/js/c4a0550b.f4702d3e.js | 1 + assets/js/e0c4e08d.ad62afba.js | 1 - assets/js/e0c4e08d.c309d43b.js | 1 + assets/js/f049f840.03bd21f7.js | 1 - assets/js/f049f840.4fd0520c.js | 1 + ...{runtime~main.d31b5940.js => runtime~main.e03e3725.js} | 2 +- blog/archive/index.html | 2 +- blog/index.html | 2 +- blog/welcome/index.html | 2 +- docs/admins-guide/index.html | 4 ++-- docs/category/content-authors-guide/index.html | 4 ++-- docs/category/curators-guide/index.html | 4 ++-- docs/category/glossary-maintainers-guide/index.html | 4 ++-- docs/category/readers-guide/index.html | 4 ++-- docs/category/terminology-author-guide/index.html | 4 ++-- docs/content-authors-guide/introduction/index.html | 4 ++-- docs/curators-guide/introduction/index.html | 4 ++-- docs/developers-guide/index.html | 6 +++--- docs/general-guide/index.html | 4 ++-- docs/glossary-maintainers-guide/introduction/index.html | 4 ++-- docs/glossary/index.html | 4 ++-- docs/how-it-came-to-be/index.html | 6 +++--- docs/intro/index.html | 4 ++-- docs/q-and-a/index.html | 8 ++++---- docs/readers-guide/introduction/index.html | 6 +++--- docs/spec-up-t-demo-site/index.html | 8 ++++---- .../external-term-references/index.html | 4 ++-- docs/terminology-authors-guide/introduction/index.html | 4 ++-- docs/terminology-authors-guide/term-references/index.html | 4 ++-- docs/this-site-maintainers/index.html | 6 +++--- docs/troubleshooting/index.html | 4 ++-- index.html | 2 +- markdown-page/index.html | 2 +- 43 files changed, 66 insertions(+), 66 deletions(-) create mode 100644 assets/js/2be7da73.128b5fd3.js delete mode 100644 assets/js/2be7da73.6c27dffc.js create mode 100644 assets/js/3dc49084.3c6f0e3f.js delete mode 100644 assets/js/3dc49084.8790a5ee.js create mode 100644 assets/js/8050fd0a.0a99c9ed.js delete mode 100644 assets/js/8050fd0a.6ee49d6c.js delete mode 100644 assets/js/9428579a.41526df7.js create mode 100644 assets/js/9428579a.c8401bd0.js delete mode 100644 assets/js/c4a0550b.6aa12fab.js create mode 100644 assets/js/c4a0550b.f4702d3e.js delete mode 100644 assets/js/e0c4e08d.ad62afba.js create mode 100644 assets/js/e0c4e08d.c309d43b.js delete mode 100644 assets/js/f049f840.03bd21f7.js create mode 100644 assets/js/f049f840.4fd0520c.js rename assets/js/{runtime~main.d31b5940.js => runtime~main.e03e3725.js} (90%) diff --git a/404.html b/404.html index 874e6fb5..517bfaa5 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | Spec-Up-T - + diff --git a/assets/js/2be7da73.128b5fd3.js b/assets/js/2be7da73.128b5fd3.js new file mode 100644 index 00000000..77263fcb --- /dev/null +++ b/assets/js/2be7da73.128b5fd3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[192],{8232:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>r,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>p});var n=i(4848),o=i(8453);const s={sidebar_position:18},a="Q & A",c={id:"q-and-a",title:"Q & A",description:"Questions and answers about Spec-Up-T.",source:"@site/docs/q-and-a.md",sourceDirName:".",slug:"/q-and-a",permalink:"/spec-up-t-website/docs/q-and-a",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/q-and-a.md",tags:[],version:"current",sidebarPosition:18,frontMatter:{sidebar_position:18},sidebar:"tutorialSidebar",previous:{title:"How it came to be",permalink:"/spec-up-t-website/docs/how-it-came-to-be"},next:{title:"Maintaining this site",permalink:"/spec-up-t-website/docs/this-site-maintainers"}},r={},p=[{value:"When I use Spec-Up-T do I get all the updates of Spec-Up too?",id:"when-i-use-spec-up-t-do-i-get-all-the-updates-of-spec-up-too",level:2},{value:"Can't we wait with the split up until because it might mess up thing for people curating the documents?",id:"cant-we-wait-with-the-split-up-until-because-it-might-mess-up-thing-for-people-curating-the-documents",level:2},{value:"How to get the original Spec-Up?",id:"how-to-get-the-original-spec-up",level:2},{value:"Where to find Spec-Up-T?",id:"where-to-find-spec-up-t",level:2},{value:"Why do I need to put commands on the command line?",id:"why-do-i-need-to-put-commands-on-the-command-line",level:2},{value:"What is the command for help?",id:"what-is-the-command-for-help",level:2},{value:"Why does Spec-Up-T look so complicated?",id:"why-does-spec-up-t-look-so-complicated",level:2},{value:"For who is Spec-Up-T?",id:"for-who-is-spec-up-t",level:2},{value:"Do you have a how-to video to get started with Spec-Up-T?",id:"do-you-have-a-how-to-video-to-get-started-with-spec-up-t",level:2},{value:"Where can I find the motivation of this move to create the Spec-Up bolt on "Spec-Up-T"?",id:"where-can-i-find-the-motivation-of-this-move-to-create-the-spec-up-bolt-on-spec-up-t",level:2},{value:"Why doesn't the Spec-Up-T repo generate a github.io-served specification itself?",id:"why-doesnt-the-spec-up-t-repo-generate-a-githubio-served-specification-itself",level:2},{value:"How to integrate Spec-Up-T in other systems",id:"how-to-integrate-spec-up-t-in-other-systems",level:2},{value:"No",id:"no",level:3},{value:"Yes",id:"yes",level:3}];function h(e){const t={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"q--a",children:"Q & A"}),"\n",(0,n.jsx)(t.p,{children:"Questions and answers about Spec-Up-T."}),"\n",(0,n.jsxs)(t.h2,{id:"when-i-use-spec-up-t-do-i-get-all-the-updates-of-spec-up-too",children:["When I use ",(0,n.jsx)(t.em,{children:"Spec-Up-T"})," do I get all the updates of ",(0,n.jsx)(t.em,{children:"Spec-Up"})," too?"]}),"\n",(0,n.jsxs)(t.p,{children:["Yes. The administrator team behind Spec-Up-T will keep ",(0,n.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"Spec-Up of DIF"})," as a strict subset of code and features."]}),"\n",(0,n.jsx)(t.h2,{id:"cant-we-wait-with-the-split-up-until-because-it-might-mess-up-thing-for-people-curating-the-documents",children:"Can't we wait with the split up until because it might mess up thing for people curating the documents?"}),"\n",(0,n.jsx)(t.p,{children:"Splitting Spec-Up content over files is not an issue for people working on the content and looking at the github.io pages of the specification. It won't affect them. They see the same generated one-page document as a result. The index.html only has enhanced features. They can offer PRs as they always could."}),"\n",(0,n.jsxs)(t.h2,{id:"how-to-get-the-original-spec-up",children:["How to get the original ",(0,n.jsx)(t.em,{children:"Spec-Up"}),"?"]}),"\n",(0,n.jsxs)(t.p,{children:["I don't want ",(0,n.jsx)(t.em,{children:"Spec-Up-T"}),", I want the original ",(0,n.jsx)(t.em,{children:"Spec-Up"}),", but then with their improvements to be able to xref, and keep track of history etc. Is this possible?"]}),"\n",(0,n.jsxs)(t.p,{children:["Some improvements have been incorporated into Spec-Up. Spec-Up will remain a subset of Spec-Up-T. The extensions you will find only in Spec-Up-T are listed in the ",(0,n.jsx)(t.a,{href:"intro#extension",children:"introduction"}),"."]}),"\n",(0,n.jsx)(t.h2,{id:"where-to-find-spec-up-t",children:"Where to find Spec-Up-T?"}),"\n",(0,n.jsxs)(t.p,{children:["Spec-Up-T is a github.com repo under Blockchainbird user: ",(0,n.jsx)(t.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"https://github.com/blockchainbird/spec-up-t"}),". You can find the source code there."]}),"\n",(0,n.jsxs)(t.admonition,{type:"warning",children:[(0,n.jsxs)(t.p,{children:["Unlike the DIF Spec-Up repository, the Spec-Up-T repository ",(0,n.jsx)(t.strong,{children:"does not generate an example specification on github.io"}),"."]}),(0,n.jsxs)(t.p,{children:["This functionality has been moved to the Spec-Up-T ",(0,n.jsx)(t.em,{children:"installer"}),"."]}),(0,n.jsxs)(t.p,{children:["For more details, refer to ",(0,n.jsx)(t.a,{href:"/spec-up-t-website/docs/admins-guide#installation",children:"the installation section in the admin guide"}),"."]})]}),"\n",(0,n.jsx)(t.h2,{id:"why-do-i-need-to-put-commands-on-the-command-line",children:"Why do I need to put commands on the command line?"}),"\n",(0,n.jsx)(t.p,{children:"Brief answer: because Spec-Up-T is based on NPM packaging and version control."}),"\n",(0,n.jsx)(t.p,{children:"To understand why more thoroughly: Spec-Up-T is team-work tooling based on NPM, git versioning and (automated) github deployment. Therefore participants incept and maintain local version of specifications on their computer, manage updates to and fro github.com and generate local test and finally production sites (github actions github.io site).\nWith this type of creation and collegial management of versions and updates come commands on the command line."}),"\n",(0,n.jsx)(t.h2,{id:"what-is-the-command-for-help",children:"What is the command for help?"}),"\n",(0,n.jsx)(t.p,{children:"TODO: npx Spec-Up-T --help gives all commands I can give."}),"\n",(0,n.jsx)(t.h2,{id:"why-does-spec-up-t-look-so-complicated",children:"Why does Spec-Up-T look so complicated?"}),"\n",(0,n.jsx)(t.p,{children:"Spec-Up was simple, Spec-Up-T looks complicated, why?"}),"\n",(0,n.jsx)(t.p,{children:'Spec-Up is a subset of Spec-Up-T. The expansion "T" complicates the handling of term definitions, - references and external references (xrefs) of term in other repo\'s glossaries.\nToIP added functionality as well: diff tooling, search bar, and navigation aids.'}),"\n",(0,n.jsx)(t.p,{children:"On the other hand, Spec-Up-T is installable via just a single command:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:"$ npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,n.jsx)(t.h2,{id:"for-who-is-spec-up-t",children:"For who is Spec-Up-T?"}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.strong,{children:"repo, command-line tools and the Docusaurus User guide is for Authors, Curators and Administrators"})," of repo's that use Spec-Up-T to run there specification effort in text, images, terms & definitions, etc."]}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.strong,{children:"resulting github.io site is intended for any user"})," interested in the content of the specification."]}),"\n",(0,n.jsx)(t.h2,{id:"do-you-have-a-how-to-video-to-get-started-with-spec-up-t",children:"Do you have a how-to video to get started with Spec-Up-T?"}),"\n",(0,n.jsxs)(t.p,{children:["Yes. Find it here: ",(0,n.jsx)(t.a,{href:"/spec-up-t-website/docs/admins-guide#short-video",children:"Instruction starter package"})]}),"\n",(0,n.jsx)(t.h2,{id:"where-can-i-find-the-motivation-of-this-move-to-create-the-spec-up-bolt-on-spec-up-t",children:'Where can I find the motivation of this move to create the Spec-Up bolt on "Spec-Up-T"?'}),"\n",(0,n.jsxs)(t.p,{children:["Our enhancement proposal and git governance strategy is here: ",(0,n.jsx)(t.a,{href:"https://hackmd.io/s1TEBBluQBSL10ZT5yRVPw",children:"https://hackmd.io/s1TEBBluQBSL10ZT5yRVPw"})]}),"\n",(0,n.jsx)(t.h2,{id:"why-doesnt-the-spec-up-t-repo-generate-a-githubio-served-specification-itself",children:"Why doesn't the Spec-Up-T repo generate a github.io-served specification itself?"}),"\n",(0,n.jsx)(t.p,{children:"The repo Spec-Up-T doesn't generate an example specification on github.io. because it's not the purpose of this repo. Your example site will pop up when \u201cspec-up-t\u201d is installed in node_modules of spec-up-t-starterpack when you run npm install."}),"\n",(0,n.jsx)(t.h2,{id:"how-to-integrate-spec-up-t-in-other-systems",children:"How to integrate Spec-Up-T in other systems"}),"\n",(0,n.jsx)(t.p,{children:"We already have a Docusaurus (or Jekyll, etc) site. Is it possible to have a Spec-Up-T specification inside this site?"}),"\n",(0,n.jsx)(t.p,{children:"Yes and No."}),"\n",(0,n.jsx)(t.h3,{id:"no",children:"No"}),"\n",(0,n.jsx)(t.p,{children:"Installing Spec-Up-T inside Docusaurus (or Jekyll, etc) is possible, however it is not recommended practice to have nested node_modules directories. Docusaurus (or Jekyll, etc) have their own node_modules directory. You can install Spec-Up-T in a sub directory in which it will get it's own node_modules directory after installation but this is not recommended."}),"\n",(0,n.jsx)(t.h3,{id:"yes",children:"Yes"}),"\n",(0,n.jsx)(t.p,{children:"You can install Spec-Up-T in it's own separate directory in your file system and generate the index.html file. This file can be moved around freely and live in it's own directory, for example in the /static directory of your Docusaurus site. You can rename index.html to foo.html or whatever you like. You could link to this file from other files in your Docusaurus site."}),"\n",(0,n.jsx)(t.p,{children:"However, the Spec-Up-T file (a one-page website) will have it's own menu and have no connection to your Docusaurus site."})]})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>c});var n=i(6540);const o={},s=n.createContext(o);function a(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2be7da73.6c27dffc.js b/assets/js/2be7da73.6c27dffc.js deleted file mode 100644 index 1b63ec7a..00000000 --- a/assets/js/2be7da73.6c27dffc.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[192],{8232:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>p,contentTitle:()=>a,default:()=>d,frontMatter:()=>s,metadata:()=>c,toc:()=>r});var n=i(4848),o=i(8453);const s={sidebar_position:16},a="Q & A",c={id:"q-and-a",title:"Q & A",description:"Questions and answers about Spec-Up-T.",source:"@site/docs/q-and-a.md",sourceDirName:".",slug:"/q-and-a",permalink:"/spec-up-t-website/docs/q-and-a",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/q-and-a.md",tags:[],version:"current",sidebarPosition:16,frontMatter:{sidebar_position:16},sidebar:"tutorialSidebar",previous:{title:"Spec-Up-T demo site",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site"},next:{title:"How it came to be",permalink:"/spec-up-t-website/docs/how-it-came-to-be"}},p={},r=[{value:"When I use Spec-Up-T do I get all the updates of Spec-Up too?",id:"when-i-use-spec-up-t-do-i-get-all-the-updates-of-spec-up-too",level:2},{value:"Can't we wait with the split up until because it might mess up thing for people curating the documents?",id:"cant-we-wait-with-the-split-up-until-because-it-might-mess-up-thing-for-people-curating-the-documents",level:2},{value:"How to get the original Spec-Up?",id:"how-to-get-the-original-spec-up",level:2},{value:"Where to find Spec-Up-T?",id:"where-to-find-spec-up-t",level:2},{value:"Why do I need to put commands on the command line?",id:"why-do-i-need-to-put-commands-on-the-command-line",level:2},{value:"What is the command for help?",id:"what-is-the-command-for-help",level:2},{value:"Why does Spec-Up-T look so complicated?",id:"why-does-spec-up-t-look-so-complicated",level:2},{value:"For who is Spec-Up-T?",id:"for-who-is-spec-up-t",level:2},{value:"Do you have a how-to video to get started with Spec-Up-T?",id:"do-you-have-a-how-to-video-to-get-started-with-spec-up-t",level:2},{value:"Where can I find the motivation of this move to create the Spec-Up bolt on "Spec-Up-T"?",id:"where-can-i-find-the-motivation-of-this-move-to-create-the-spec-up-bolt-on-spec-up-t",level:2},{value:"Why doesn't the Spec-Up-T repo generate a github.io-served specification itself?",id:"why-doesnt-the-spec-up-t-repo-generate-a-githubio-served-specification-itself",level:2},{value:"How to integrate Spec-Up-T in other systems",id:"how-to-integrate-spec-up-t-in-other-systems",level:2},{value:"No",id:"no",level:3},{value:"Yes",id:"yes",level:3}];function h(e){const t={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"q--a",children:"Q & A"}),"\n",(0,n.jsx)(t.p,{children:"Questions and answers about Spec-Up-T."}),"\n",(0,n.jsxs)(t.h2,{id:"when-i-use-spec-up-t-do-i-get-all-the-updates-of-spec-up-too",children:["When I use ",(0,n.jsx)(t.em,{children:"Spec-Up-T"})," do I get all the updates of ",(0,n.jsx)(t.em,{children:"Spec-Up"})," too?"]}),"\n",(0,n.jsxs)(t.p,{children:["Yes. The administrator team behind Spec-Up-T will keep ",(0,n.jsx)(t.a,{href:"https://github.com/decentralized-identity/spec-up",children:"Spec-Up of DIF"})," as a strict subset of code and features."]}),"\n",(0,n.jsx)(t.h2,{id:"cant-we-wait-with-the-split-up-until-because-it-might-mess-up-thing-for-people-curating-the-documents",children:"Can't we wait with the split up until because it might mess up thing for people curating the documents?"}),"\n",(0,n.jsx)(t.p,{children:"Splitting Spec-Up content over files is not an issue for people working on the content and looking at the github.io pages of the specification. It won't affect them. They see the same generated one-page document as a result. The index.html only has enhanced features. They can offer PRs as they always could."}),"\n",(0,n.jsxs)(t.h2,{id:"how-to-get-the-original-spec-up",children:["How to get the original ",(0,n.jsx)(t.em,{children:"Spec-Up"}),"?"]}),"\n",(0,n.jsxs)(t.p,{children:["I don't want ",(0,n.jsx)(t.em,{children:"Spec-Up-T"}),", I want the original ",(0,n.jsx)(t.em,{children:"Spec-Up"}),", but then with their improvements to be able to xref, and keep track of history etc. Is this possible?"]}),"\n",(0,n.jsxs)(t.p,{children:["Some improvements have been incorporated into Spec-Up. Spec-Up will remain a subset of Spec-Up-T. The extensions you will find only in Spec-Up-T are listed in the ",(0,n.jsx)(t.a,{href:"intro#extension",children:"introduction"}),"."]}),"\n",(0,n.jsx)(t.h2,{id:"where-to-find-spec-up-t",children:"Where to find Spec-Up-T?"}),"\n",(0,n.jsxs)(t.p,{children:["Spec-Up-T is a github.com repo under Blockchainbird user: ",(0,n.jsx)(t.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"https://github.com/blockchainbird/spec-up-t"}),". You can find the source code there."]}),"\n",(0,n.jsxs)(t.admonition,{type:"warning",children:[(0,n.jsxs)(t.p,{children:["Unlike the DIF Spec-Up repository, the Spec-Up-T repository ",(0,n.jsx)(t.strong,{children:"does not generate an example specification on github.io"}),"."]}),(0,n.jsxs)(t.p,{children:["This functionality has been moved to the Spec-Up-T ",(0,n.jsx)(t.em,{children:"installer"}),"."]}),(0,n.jsxs)(t.p,{children:["For more details, refer to ",(0,n.jsx)(t.a,{href:"/spec-up-t-website/docs/admins-guide#installation",children:"the installation section in the admin guide"}),"."]})]}),"\n",(0,n.jsx)(t.h2,{id:"why-do-i-need-to-put-commands-on-the-command-line",children:"Why do I need to put commands on the command line?"}),"\n",(0,n.jsx)(t.p,{children:"Brief answer: because Spec-Up-T is based on NPM packaging and version control."}),"\n",(0,n.jsx)(t.p,{children:"To understand why more thoroughly: Spec-Up-T is team-work tooling based on NPM, git versioning and (automated) github deployment. Therefore participants incept and maintain local version of specifications on their computer, manage updates to and fro github.com and generate local test and finally production sites (github actions github.io site).\nWith this type of creation and collegial management of versions and updates come commands on the command line."}),"\n",(0,n.jsx)(t.h2,{id:"what-is-the-command-for-help",children:"What is the command for help?"}),"\n",(0,n.jsx)(t.p,{children:"TODO: npx Spec-Up-T --help gives all commands I can give."}),"\n",(0,n.jsx)(t.h2,{id:"why-does-spec-up-t-look-so-complicated",children:"Why does Spec-Up-T look so complicated?"}),"\n",(0,n.jsx)(t.p,{children:"Spec-Up was simple, Spec-Up-T looks complicated, why?"}),"\n",(0,n.jsx)(t.p,{children:'Spec-Up is a subset of Spec-Up-T. The expansion "T" complicates the handling of term definitions, - references and external references (xrefs) of term in other repo\'s glossaries.\nToIP added functionality as well: diff tooling, search bar, and navigation aids.'}),"\n",(0,n.jsx)(t.p,{children:"On the other hand, Spec-Up-T is installable via just a single command:"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{children:"$ npx create-spec-up-t my-spec-up-t-website\n"})}),"\n",(0,n.jsx)(t.h2,{id:"for-who-is-spec-up-t",children:"For who is Spec-Up-T?"}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.strong,{children:"repo, command-line tools and the Docusaurus User guide is for Authors, Curators and Administrators"})," of repo's that use Spec-Up-T to run there specification effort in text, images, terms & definitions, etc."]}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.strong,{children:"resulting github.io site is intended for any user"})," interested in the content of the specification."]}),"\n",(0,n.jsx)(t.h2,{id:"do-you-have-a-how-to-video-to-get-started-with-spec-up-t",children:"Do you have a how-to video to get started with Spec-Up-T?"}),"\n",(0,n.jsxs)(t.p,{children:["Yes. Find it here: ",(0,n.jsx)(t.a,{href:"/spec-up-t-website/docs/admins-guide#short-video",children:"Instruction starter package"})]}),"\n",(0,n.jsx)(t.h2,{id:"where-can-i-find-the-motivation-of-this-move-to-create-the-spec-up-bolt-on-spec-up-t",children:'Where can I find the motivation of this move to create the Spec-Up bolt on "Spec-Up-T"?'}),"\n",(0,n.jsxs)(t.p,{children:["Our enhancement proposal and git governance strategy is here: ",(0,n.jsx)(t.a,{href:"https://hackmd.io/s1TEBBluQBSL10ZT5yRVPw",children:"https://hackmd.io/s1TEBBluQBSL10ZT5yRVPw"})]}),"\n",(0,n.jsx)(t.h2,{id:"why-doesnt-the-spec-up-t-repo-generate-a-githubio-served-specification-itself",children:"Why doesn't the Spec-Up-T repo generate a github.io-served specification itself?"}),"\n",(0,n.jsx)(t.p,{children:"The repo Spec-Up-T doesn't generate an example specification on github.io. because it's not the purpose of this repo. Your example site will pop up when \u201cspec-up-t\u201d is installed in node_modules of spec-up-t-starterpack when you run npm install."}),"\n",(0,n.jsx)(t.h2,{id:"how-to-integrate-spec-up-t-in-other-systems",children:"How to integrate Spec-Up-T in other systems"}),"\n",(0,n.jsx)(t.p,{children:"We already have a Docusaurus (or Jekyll, etc) site. Is it possible to have a Spec-Up-T specification inside this site?"}),"\n",(0,n.jsx)(t.p,{children:"Yes and No."}),"\n",(0,n.jsx)(t.h3,{id:"no",children:"No"}),"\n",(0,n.jsx)(t.p,{children:"Installing Spec-Up-T inside Docusaurus (or Jekyll, etc) is possible, however it is not recommended practice to have nested node_modules directories. Docusaurus (or Jekyll, etc) have their own node_modules directory. You can install Spec-Up-T in a sub directory in which it will get it's own node_modules directory after installation but this is not recommended."}),"\n",(0,n.jsx)(t.h3,{id:"yes",children:"Yes"}),"\n",(0,n.jsx)(t.p,{children:"You can install Spec-Up-T in it's own separate directory in your file system and generate the index.html file. This file can be moved around freely and live in it's own directory, for example in the /static directory of your Docusaurus site. You can rename index.html to foo.html or whatever you like. You could link to this file from other files in your Docusaurus site."}),"\n",(0,n.jsx)(t.p,{children:"However, the Spec-Up-T file (a one-page website) will have it's own menu and have no connection to your Docusaurus site."})]})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>c});var n=i(6540);const o={},s=n.createContext(o);function a(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3dc49084.3c6f0e3f.js b/assets/js/3dc49084.3c6f0e3f.js new file mode 100644 index 00000000..180e3a5b --- /dev/null +++ b/assets/js/3dc49084.3c6f0e3f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[392],{1091:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>l});var s=n(4848),t=n(8453);const o={sidebar_position:15},d="Developers Guide",r={id:"developers-guide",title:"Developers Guide",description:"This is the developers guide for the Spec-Up-T system.",source:"@site/docs/developers-guide.md",sourceDirName:".",slug:"/developers-guide",permalink:"/spec-up-t-website/docs/developers-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developers-guide.md",tags:[],version:"current",sidebarPosition:15,frontMatter:{sidebar_position:15},sidebar:"tutorialSidebar",previous:{title:"Readers Guide",permalink:"/spec-up-t-website/docs/readers-guide/introduction"},next:{title:"Spec-Up-T demo",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site"}},c={},l=[{value:"How do you get a new version of Spec-Up-T live?",id:"how-do-you-get-a-new-version-of-spec-up-t-live",level:2},{value:"Adding client-side functionality",id:"adding-client-side-functionality",level:2},{value:"Gulp",id:"gulp",level:2},{value:"Adding server-side functionality",id:"adding-server-side-functionality",level:2}];function a(e){const i={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(i.h1,{id:"developers-guide",children:"Developers Guide"}),"\n",(0,s.jsx)(i.p,{children:"This is the developers guide for the Spec-Up-T system."}),"\n",(0,s.jsxs)(i.p,{children:["The repo can be found ",(0,s.jsx)(i.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"here"}),"."]}),"\n",(0,s.jsx)(i.h2,{id:"how-do-you-get-a-new-version-of-spec-up-t-live",children:"How do you get a new version of Spec-Up-T live?"}),"\n",(0,s.jsx)(i.p,{children:"If you want to add new functionality to Spec-Up-T you will find below how to proceed."}),"\n",(0,s.jsx)(i.p,{children:"There are two repos that come into play:"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:[(0,s.jsx)(i.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"The Spec-Up-T repo"}),", with ",(0,s.jsx)(i.a,{href:"https://www.npmjs.com/package/spec-up-t",children:"associated NPM package"})]}),"\n",(0,s.jsxs)(i.li,{children:[(0,s.jsx)(i.a,{href:"https://github.com/blockchainbird/spec-up-t-starter-pack",children:"The Spec-Up-T installer repo"}),", with ",(0,s.jsx)(i.a,{href:"https://www.npmjs.com/package/create-spec-up-t",children:"associated NPM package"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["The Spec-Up-T installer uses Spec-Up-T as a package in node_modules, which is installed via ",(0,s.jsx)(i.code,{children:"npm install"})," after you install the Spec-Up-T installer itself (see Admin section for this)."]}),"\n",(0,s.jsx)(i.p,{children:"How to update Git repositories goes too far here, you can find a lot of info about that online."}),"\n",(0,s.jsx)(i.p,{children:"How to publish an updated package version to NPM:"}),"\n",(0,s.jsxs)(i.ul,{children:["\n",(0,s.jsxs)(i.li,{children:['Update the "version" in ',(0,s.jsx)(i.code,{children:"package.json"})," to a higher number (use ",(0,s.jsx)(i.a,{href:"https://semver.org/",children:"SemVer"}),"), for example go from\n",(0,s.jsx)(i.code,{children:'"version": "0.11.29"'})," to ",(0,s.jsx)(i.code,{children:'"version": "0.11.30"'})]}),"\n",(0,s.jsxs)(i.li,{children:["Run ",(0,s.jsx)(i.code,{children:"npm publish"})]}),"\n"]}),"\n",(0,s.jsxs)(i.p,{children:["Note: The The Spec-Up-T installer repo has two ",(0,s.jsx)(i.code,{children:"package.json"}),"s. One in the root, it belongs to the repo itself. The other inside the directory that contains a full Spec-Up-T installation. This is the ",(0,s.jsx)(i.code,{children:"package.json"})," that will be used later. The first one is only used for the installation itself. For simplicity, keep both version numbers the same."]}),"\n",(0,s.jsx)(i.p,{children:"The new package will usually be available as soon as it is uploaded."}),"\n",(0,s.jsx)(i.h2,{id:"adding-client-side-functionality",children:"Adding client-side functionality"}),"\n",(0,s.jsxs)(i.p,{children:["Client-side JavaScript and CSS can be found in these directories: ",(0,s.jsx)(i.code,{children:"/assets/js"})," and ",(0,s.jsx)(i.code,{children:"/assets/css"}),"."]}),"\n",(0,s.jsxs)(i.p,{children:["This code must first be \u201ccompiled\u201d before it enters ",(0,s.jsx)(i.code,{children:"index.html"}),". Compiling in this case means that it will end up in the directory ",(0,s.jsx)(i.code,{children:"/assets/compiled"}),". If it is there, it will end up in a newly generated ",(0,s.jsx)(i.code,{children:"index.html"})," via the ",(0,s.jsx)(i.code,{children:"render"})," step. For rendering, see the admin section."]}),"\n",(0,s.jsxs)(i.p,{children:["This is the command to compile: ",(0,s.jsx)(i.code,{children:"gulp compile"})]}),"\n",(0,s.jsx)(i.p,{children:"So, if you have written client-side JavaScript, or custom CSS you need to take the following steps to get this code working (the \u201c$\u201d at the beginning is the command prompt, and you should not type it):"}),"\n",(0,s.jsx)(i.pre,{children:(0,s.jsx)(i.code,{children:"$ gulp compile\n"})}),"\n",(0,s.jsx)(i.p,{children:"Wait for the code to finish. Then:"}),"\n",(0,s.jsx)(i.pre,{children:(0,s.jsx)(i.code,{children:"$ npm run render\n"})}),"\n",(0,s.jsxs)(i.p,{children:["Now your ",(0,s.jsx)(i.code,{children:"index.html"})," file should be created or updated."]}),"\n",(0,s.jsx)(i.h2,{id:"gulp",children:"Gulp"}),"\n",(0,s.jsxs)(i.p,{children:["Of course, you can only use Gulp if you have it ",(0,s.jsx)(i.a,{href:"https://gulpjs.com/docs/en/getting-started/quick-start",children:"installed"}),"."]}),"\n",(0,s.jsx)(i.admonition,{type:"warning",children:(0,s.jsx)(i.p,{children:"If Gulp suddenly stops working even though it worked before, it could be because you are using NVM and have a different Node.js version active."})}),"\n",(0,s.jsx)(i.h2,{id:"adding-server-side-functionality",children:"Adding server-side functionality"}),"\n",(0,s.jsx)(i.p,{children:"To be written."})]})}function p(e={}){const{wrapper:i}={...(0,t.R)(),...e.components};return i?(0,s.jsx)(i,{...e,children:(0,s.jsx)(a,{...e})}):a(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>d,x:()=>r});var s=n(6540);const t={},o=s.createContext(t);function d(e){const i=s.useContext(o);return s.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),s.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/3dc49084.8790a5ee.js b/assets/js/3dc49084.8790a5ee.js deleted file mode 100644 index 2e097102..00000000 --- a/assets/js/3dc49084.8790a5ee.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[392],{1091:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>o,metadata:()=>d,toc:()=>l});var t=n(4848),s=n(8453);const o={sidebar_position:18},r="Developers Guide",d={id:"developers-guide",title:"Developers Guide",description:"This is the developers guide for the Spec-Up-T system.",source:"@site/docs/developers-guide.md",sourceDirName:".",slug:"/developers-guide",permalink:"/spec-up-t-website/docs/developers-guide",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/developers-guide.md",tags:[],version:"current",sidebarPosition:18,frontMatter:{sidebar_position:18},sidebar:"tutorialSidebar",previous:{title:"How it came to be",permalink:"/spec-up-t-website/docs/how-it-came-to-be"},next:{title:"Maintaining this site",permalink:"/spec-up-t-website/docs/this-site-maintainers"}},c={},l=[{value:"How do you get a new version of Spec-Up-T live?",id:"how-do-you-get-a-new-version-of-spec-up-t-live",level:2},{value:"Adding client-side functionality",id:"adding-client-side-functionality",level:2},{value:"Gulp",id:"gulp",level:2},{value:"Adding server-side functionality",id:"adding-server-side-functionality",level:2}];function a(e){const i={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",li:"li",p:"p",pre:"pre",ul:"ul",...(0,s.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.h1,{id:"developers-guide",children:"Developers Guide"}),"\n",(0,t.jsx)(i.p,{children:"This is the developers guide for the Spec-Up-T system."}),"\n",(0,t.jsxs)(i.p,{children:["The repo can be found ",(0,t.jsx)(i.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"here"}),"."]}),"\n",(0,t.jsx)(i.h2,{id:"how-do-you-get-a-new-version-of-spec-up-t-live",children:"How do you get a new version of Spec-Up-T live?"}),"\n",(0,t.jsx)(i.p,{children:"If you want to add new functionality to Spec-Up-T you will find below how to proceed."}),"\n",(0,t.jsx)(i.p,{children:"There are two repos that come into play:"}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.a,{href:"https://github.com/blockchainbird/spec-up-t",children:"The Spec-Up-T repo"}),", with ",(0,t.jsx)(i.a,{href:"https://www.npmjs.com/package/spec-up-t",children:"associated NPM package"})]}),"\n",(0,t.jsxs)(i.li,{children:[(0,t.jsx)(i.a,{href:"https://github.com/blockchainbird/spec-up-t-starter-pack",children:"The Spec-Up-T installer repo"}),", with ",(0,t.jsx)(i.a,{href:"https://www.npmjs.com/package/create-spec-up-t",children:"associated NPM package"})]}),"\n"]}),"\n",(0,t.jsxs)(i.p,{children:["The Spec-Up-T installer uses Spec-Up-T as a package in node_modules, which is installed via ",(0,t.jsx)(i.code,{children:"npm install"})," after you install the Spec-Up-T installer itself (see Admin section for this)."]}),"\n",(0,t.jsx)(i.p,{children:"How to update Git repositories goes too far here, you can find a lot of info about that online."}),"\n",(0,t.jsx)(i.p,{children:"How to publish an updated package version to NPM:"}),"\n",(0,t.jsxs)(i.ul,{children:["\n",(0,t.jsxs)(i.li,{children:['Update the "version" in ',(0,t.jsx)(i.code,{children:"package.json"})," to a higher number (use ",(0,t.jsx)(i.a,{href:"https://semver.org/",children:"SemVer"}),"), for example go from\n",(0,t.jsx)(i.code,{children:'"version": "0.11.29"'})," to ",(0,t.jsx)(i.code,{children:'"version": "0.11.30"'})]}),"\n",(0,t.jsxs)(i.li,{children:["Run ",(0,t.jsx)(i.code,{children:"npm publish"})]}),"\n"]}),"\n",(0,t.jsxs)(i.p,{children:["Note: The The Spec-Up-T installer repo has two ",(0,t.jsx)(i.code,{children:"package.json"}),"s. One in the root, it belongs to the repo itself. The other inside the directory that contains a full Spec-Up-T installation. This is the ",(0,t.jsx)(i.code,{children:"package.json"})," that will be used later. The first one is only used for the installation itself. For simplicity, keep both version numbers the same."]}),"\n",(0,t.jsx)(i.p,{children:"The new package will usually be available as soon as it is uploaded."}),"\n",(0,t.jsx)(i.h2,{id:"adding-client-side-functionality",children:"Adding client-side functionality"}),"\n",(0,t.jsxs)(i.p,{children:["Client-side JavaScript and CSS can be found in these directories: ",(0,t.jsx)(i.code,{children:"/assets/js"})," and ",(0,t.jsx)(i.code,{children:"/assets/css"}),"."]}),"\n",(0,t.jsxs)(i.p,{children:["This code must first be \u201ccompiled\u201d before it enters ",(0,t.jsx)(i.code,{children:"index.html"}),". Compiling in this case means that it will end up in the directory ",(0,t.jsx)(i.code,{children:"/assets/compiled"}),". If it is there, it will end up in a newly generated ",(0,t.jsx)(i.code,{children:"index.html"})," via the ",(0,t.jsx)(i.code,{children:"render"})," step. For rendering, see the admin section."]}),"\n",(0,t.jsxs)(i.p,{children:["This is the command to compile: ",(0,t.jsx)(i.code,{children:"gulp compile"})]}),"\n",(0,t.jsx)(i.p,{children:"So, if you have written client-side JavaScript, or custom CSS you need to take the following steps to get this code working (the \u201c$\u201d at the beginning is the command prompt, and you should not type it):"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{children:"$ gulp compile\n"})}),"\n",(0,t.jsx)(i.p,{children:"Wait for the code to finish. Then:"}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{children:"$ npm run render\n"})}),"\n",(0,t.jsxs)(i.p,{children:["Now your ",(0,t.jsx)(i.code,{children:"index.html"})," file should be created or updated."]}),"\n",(0,t.jsx)(i.h2,{id:"gulp",children:"Gulp"}),"\n",(0,t.jsxs)(i.p,{children:["Of course, you can only use Gulp if you have it ",(0,t.jsx)(i.a,{href:"https://gulpjs.com/docs/en/getting-started/quick-start",children:"installed"}),"."]}),"\n",(0,t.jsx)(i.admonition,{type:"warning",children:(0,t.jsx)(i.p,{children:"If Gulp suddenly stops working even though it worked before, it could be because you are using NVM and have a different Node.js version active."})}),"\n",(0,t.jsx)(i.h2,{id:"adding-server-side-functionality",children:"Adding server-side functionality"}),"\n",(0,t.jsx)(i.p,{children:"To be written."})]})}function h(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},8453:(e,i,n)=>{n.d(i,{R:()=>r,x:()=>d});var t=n(6540);const s={},o=t.createContext(s);function r(e){const i=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),t.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8050fd0a.0a99c9ed.js b/assets/js/8050fd0a.0a99c9ed.js new file mode 100644 index 00000000..20a9e8a9 --- /dev/null +++ b/assets/js/8050fd0a.0a99c9ed.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[871],{411:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>d,toc:()=>c});var i=r(4848),s=r(8453);const n={sidebar_position:1},o="Readers Guide",d={id:"readers-guide/introduction",title:"Readers Guide",description:"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.",source:"@site/docs/readers-guide/introduction.md",sourceDirName:"readers-guide",slug:"/readers-guide/introduction",permalink:"/spec-up-t-website/docs/readers-guide/introduction",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/readers-guide/introduction.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Readers Guide",permalink:"/spec-up-t-website/docs/category/readers-guide"},next:{title:"Developers Guide",permalink:"/spec-up-t-website/docs/developers-guide"}},a={},c=[];function u(e){const t={h1:"h1",p:"p",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"readers-guide",children:"Readers Guide"}),"\n",(0,i.jsx)(t.p,{children:"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered."})]})}function p(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},8453:(e,t,r)=>{r.d(t,{R:()=>o,x:()=>d});var i=r(6540);const s={},n=i.createContext(s);function o(e){const t=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8050fd0a.6ee49d6c.js b/assets/js/8050fd0a.6ee49d6c.js deleted file mode 100644 index e5328e9f..00000000 --- a/assets/js/8050fd0a.6ee49d6c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[871],{411:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>n,metadata:()=>d,toc:()=>c});var i=s(4848),r=s(8453);const n={sidebar_position:1},o="Readers Guide",d={id:"readers-guide/introduction",title:"Readers Guide",description:"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.",source:"@site/docs/readers-guide/introduction.md",sourceDirName:"readers-guide",slug:"/readers-guide/introduction",permalink:"/spec-up-t-website/docs/readers-guide/introduction",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/readers-guide/introduction.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"tutorialSidebar",previous:{title:"Readers Guide",permalink:"/spec-up-t-website/docs/category/readers-guide"},next:{title:"Spec-Up-T demo site",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site"}},a={},c=[];function u(e){const t={h1:"h1",p:"p",...(0,r.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h1,{id:"readers-guide",children:"Readers Guide"}),"\n",(0,i.jsx)(t.p,{children:"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered."})]})}function p(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(u,{...e})}):u(e)}},8453:(e,t,s)=>{s.d(t,{R:()=>o,x:()=>d});var i=s(6540);const r={},n=i.createContext(r);function o(e){const t=i.useContext(n);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(n.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9428579a.41526df7.js b/assets/js/9428579a.41526df7.js deleted file mode 100644 index f502c3dd..00000000 --- a/assets/js/9428579a.41526df7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[167],{7879:(e,i,t)=>{t.r(i),t.d(i,{assets:()=>c,contentTitle:()=>a,default:()=>p,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var n=t(4848),s=t(8453);const o={sidebar_position:19},a="Maintaining this site",r={id:"this-site-maintainers",title:"Maintaining this site",description:"Here you will find information about things specific to this site.",source:"@site/docs/this-site-maintainers.md",sourceDirName:".",slug:"/this-site-maintainers",permalink:"/spec-up-t-website/docs/this-site-maintainers",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/this-site-maintainers.md",tags:[],version:"current",sidebarPosition:19,frontMatter:{sidebar_position:19},sidebar:"tutorialSidebar",previous:{title:"Developers Guide",permalink:"/spec-up-t-website/docs/developers-guide"},next:{title:"Glossary",permalink:"/spec-up-t-website/docs/glossary"}},c={},d=[{value:"Updating the Demo Site",id:"updating-the-demo-site",level:2}];function l(e){const i={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h1,{id:"maintaining-this-site",children:"Maintaining this site"}),"\n",(0,n.jsx)(i.p,{children:"Here you will find information about things specific to this site."}),"\n",(0,n.jsx)(i.h2,{id:"updating-the-demo-site",children:"Updating the Demo Site"}),"\n",(0,n.jsxs)(i.p,{children:["The ",(0,n.jsx)(i.a,{href:"/spec-up-t-website/docs/spec-up-t-demo-site",children:"demo page"})," contains an example of a Spec-Up-T installation in an iFrame. This ",(0,n.jsx)(i.code,{children:"index.html"})," file is in ",(0,n.jsx)(i.code,{children:"/static/spec-up-t-demo/docs/"}),"."]}),"\n",(0,n.jsxs)(i.p,{children:["This ",(0,n.jsx)(i.code,{children:"index.html"})," file is a standard Spec-Up-T installation, as described in the ",(0,n.jsx)(i.a,{href:"/spec-up-t-website/docs/admins-guide#installation",children:"admin section"}),"."]}),"\n",(0,n.jsxs)(i.p,{children:["This ",(0,n.jsx)(i.code,{children:"index.html"})," file is located in the GitHub repository of this site (the site you are now reading). The Spec-Up-T installation that generated the index file is not stored in any repository since it is a standard installation. You can install and generate it anywhere on your computer, then copy the index file to ",(0,n.jsx)(i.code,{children:"/static/spec-up-t-demo/docs/"}),"."]})]})}function p(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,i,t)=>{t.d(i,{R:()=>a,x:()=>r});var n=t(6540);const s={},o=n.createContext(s);function a(e){const i=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function r(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(o.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9428579a.c8401bd0.js b/assets/js/9428579a.c8401bd0.js new file mode 100644 index 00000000..0e9f0625 --- /dev/null +++ b/assets/js/9428579a.c8401bd0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[167],{7879:(e,t,i)=>{i.r(t),i.d(t,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>o,metadata:()=>r,toc:()=>d});var n=i(4848),s=i(8453);const o={sidebar_position:19},a="Maintaining this site",r={id:"this-site-maintainers",title:"Maintaining this site",description:"Here you will find information about things specific to this site.",source:"@site/docs/this-site-maintainers.md",sourceDirName:".",slug:"/this-site-maintainers",permalink:"/spec-up-t-website/docs/this-site-maintainers",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/this-site-maintainers.md",tags:[],version:"current",sidebarPosition:19,frontMatter:{sidebar_position:19},sidebar:"tutorialSidebar",previous:{title:"Q & A",permalink:"/spec-up-t-website/docs/q-and-a"},next:{title:"Glossary",permalink:"/spec-up-t-website/docs/glossary"}},c={},d=[{value:"Updating the Demo Site",id:"updating-the-demo-site",level:2}];function l(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"maintaining-this-site",children:"Maintaining this site"}),"\n",(0,n.jsx)(t.p,{children:"Here you will find information about things specific to this site."}),"\n",(0,n.jsx)(t.h2,{id:"updating-the-demo-site",children:"Updating the Demo Site"}),"\n",(0,n.jsxs)(t.p,{children:["The ",(0,n.jsx)(t.a,{href:"/spec-up-t-website/docs/spec-up-t-demo-site",children:"demo page"})," contains an example of a Spec-Up-T installation in an iFrame. This ",(0,n.jsx)(t.code,{children:"index.html"})," file is in ",(0,n.jsx)(t.code,{children:"/static/spec-up-t-demo/docs/"}),"."]}),"\n",(0,n.jsxs)(t.p,{children:["This ",(0,n.jsx)(t.code,{children:"index.html"})," file is a standard Spec-Up-T installation, as described in the ",(0,n.jsx)(t.a,{href:"/spec-up-t-website/docs/admins-guide#installation",children:"admin section"}),"."]}),"\n",(0,n.jsxs)(t.p,{children:["This ",(0,n.jsx)(t.code,{children:"index.html"})," file is located in the GitHub repository of this site (the site you are now reading). The Spec-Up-T installation that generated the index file is not stored in any repository since it is a standard installation. You can install and generate it anywhere on your computer, then copy the index file to ",(0,n.jsx)(t.code,{children:"/static/spec-up-t-demo/docs/"}),"."]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},8453:(e,t,i)=>{i.d(t,{R:()=>a,x:()=>r});var n=i(6540);const s={},o=n.createContext(s);function a(e){const t=n.useContext(o);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function r(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),n.createElement(o.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c4a0550b.6aa12fab.js b/assets/js/c4a0550b.6aa12fab.js deleted file mode 100644 index 3b4179d4..00000000 --- a/assets/js/c4a0550b.6aa12fab.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[509],{4028:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(4848),o=t(8453);const s={sidebar_position:17},a="How it came to be",r={id:"how-it-came-to-be",title:"How it came to be",description:"The ToIP Terms extension of Spec-Up",source:"@site/docs/how-it-came-to-be.md",sourceDirName:".",slug:"/how-it-came-to-be",permalink:"/spec-up-t-website/docs/how-it-came-to-be",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/how-it-came-to-be.md",tags:[],version:"current",sidebarPosition:17,frontMatter:{sidebar_position:17},sidebar:"tutorialSidebar",previous:{title:"Q & A",permalink:"/spec-up-t-website/docs/q-and-a"},next:{title:"Developers Guide",permalink:"/spec-up-t-website/docs/developers-guide"}},c={},d=[{value:"The ToIP Terms extension of Spec-Up",id:"the-toip-terms-extension-of-spec-up",level:2},{value:"What's different?",id:"whats-different",level:3},{value:"A rock and a hard place",id:"a-rock-and-a-hard-place",level:3},{value:"Versioning of terms and interactive use of specifications",id:"versioning-of-terms-and-interactive-use-of-specifications",level:3},{value:"No-go solo",id:"no-go-solo",level:3},{value:"How do we stay in sync?",id:"how-do-we-stay-in-sync",level:3},{value:"Charting territories",id:"charting-territories",level:3},{value:"Perspective: Authors",id:"perspective-authors",level:3},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this--",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---1",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---2",level:4},{value:"Important note",id:"important-note",level:4},{value:"Perspective: Coders",id:"perspective-coders",level:3},{value:"Legend",id:"legend",level:3},{value:"Preparatory code organization and Git configuration in current DIF Spec-Up",id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"how-it-came-to-be",children:"How it came to be"}),"\n",(0,i.jsx)(n.h2,{id:"the-toip-terms-extension-of-spec-up",children:"The ToIP Terms extension of Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"This article is meant for technical experts in Spec-Up and git."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"What is Spec-Up, what is Spec-Up-T and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way?\nA brief answer to all of these questions is \u2018yes\u2019. This article elaborates on the details and comes up with an elegant, yet simple and practical, git governance proposal that will keep the ties between Spec-Up and Spec-Up-T in tact."})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"\u201cSpec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.\u201d\nBy: Spec-Up creator Daniel Buchner, at Decentralised Identity Foundation (DIF)."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Spec-Up is a great tool for creating online standardization specifications. We use it a lot at TrustoverIP. Recently, we also started contributing to DIF\u2019s Spec-Up code."}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we support the original objective of DIF with Spec-Up. Spec-Up, as it is at present, gives us a base that we want to stay in sync with. Why do we want to merge changes to and fro DIF's spec-up?"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"To acknowledge the great work accomplished by DIF"}),"\n",(0,i.jsx)(n.li,{children:"Support a common specification tool in the SSI field that overarches the active umbrella organisations"}),"\n",(0,i.jsx)(n.li,{children:"last but not least: to combine current and future efforts."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"whats-different",children:"What's different?"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we do more with concepts and terminology than has been foreseen with Spec-Up. For example: versioning of individual terms, and versioning of who references them and when, has been proven a key to success of building consensus within ToIP."}),"\n",(0,i.jsx)(n.p,{children:"To offer ToIP-specific Spec-Up functionality we need to extent the code. Happily, we are able to extend Spec-Up with specific front-end and back-end functionality. As we did before, we could offer those extensions as a PR to DIF\u2019s Spec-Up. In practise this means: and ask Daniel Buchner to have a look at it and ask him to consider merging the new code into the main code repository of Spec-Up."}),"\n",(0,i.jsx)(n.h3,{id:"a-rock-and-a-hard-place",children:"A rock and a hard place"}),"\n",(0,i.jsxs)(n.p,{children:["What could be problematic for ToIP about the approach to present PRs regarding our ",(0,i.jsx)(n.em,{children:"specific"})," ToIP code to DIF's Spec-Up:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"We put Daniel Buchner / DIF on the critical path for ToIP development"}),"\n",(0,i.jsx)(n.li,{children:"We ask DIF to accept bolt-ons to a lean and mean Spec-Up"}),"\n",(0,i.jsx)(n.li,{children:"We trigger discussions about objectives of Spec-Up, where we want to implement Spec-Up right away.\nThis leaves us between a rock and a hard place if we were to proceed as before."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"versioning-of-terms-and-interactive-use-of-specifications",children:"Versioning of terms and interactive use of specifications"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we have a need for a Spec-Up tool that has a slightly different angle to static site generation for specification-documents:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"because we have a ToIP-specific fine-grained view on concepts and terminology."}),"\n",(0,i.jsx)(n.li,{children:"we might want to have a few front-end amendments that would not match the lean and mean Spec-Up at DIF with the vision to have a compact simple solution for standards documents."}),"\n",(0,i.jsxs)(n.li,{children:["We might want to extend the layout capabilities to adhere to standards of specific target audiences.\nThe last reason is that we want to move faster with as little \u201cdesks to go for a stamp\u201d as possible.\nWe call this extended Spec-Up ",(0,i.jsx)(n.em,{children:"Spec-Up-T"}),", where \u2019T\u2019 can both cover - or refer to - \u2018Terms\u2019 and \u2018ToIP\u2019."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"no-go-solo",children:"No-go solo"}),"\n",(0,i.jsxs)(n.p,{children:["What if we were to declare a part of the code in the DIF Spec-Up repository a ",(0,i.jsx)(n.em,{children:"no-go area"}),"? More specifically, within a common shared area we only change code under consensus by offering PRs to be accepted and merged by DIF. That would make coding easier and offer a clear division in feature sets of Spec-Up and Spec-Up-T."]}),"\n",(0,i.jsx)(n.p,{children:"Due to the reasons listed above, we need to partly develop solo in a fork (Spec-Up-T), and then we could offer our work to DIF. If they merge our code in their repo, that\u2019d be great because it would confirm consensus about objectives behind Spec-Up. But this mutual merge is optional for DIF."}),"\n",(0,i.jsx)(n.h3,{id:"how-do-we-stay-in-sync",children:"How do we stay in sync?"}),"\n",(0,i.jsx)(n.p,{children:'We propose a "bi-directional sync" or "mutual synchronization" model. In this model, both repositories are equally important, and changes are synced between them at will to ensure they both contain the same information or updates.'}),"\n",(0,i.jsx)(n.h3,{id:"charting-territories",children:"Charting territories"}),"\n",(0,i.jsx)(n.p,{children:"For clarity, there are three main perspectives on Spec-Up(-T) publicly AND on your local computer:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Authors"})," look at ready-to-use Spec-Up github.com version (after running Starter-pack)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Coders"})," look at the NPM Spec-Up libraries"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Users"})," see the generated end-product on github.io (index.html)"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"perspective-authors",children:"Perspective: Authors"}),"\n",(0,i.jsxs)(n.p,{children:["Authors of a new Specification start with an empty directory on their local machine. After the command ",(0,i.jsx)(n.code,{children:"npm install spec-up-T"})," the spec directory and all the files mentioned will be present. The grey files are not to be touched because they are generated results. The green files can be altered to fill and configure the new Specification. A Spec-Up-T install will typically include all DIF Spec-Up code."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this--",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"After this an author can start filling the project, and configuring Spec-Up(-T)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(7081).A+"",width:"1730",height:"878"})}),"\n",(0,i.jsxs)(n.p,{children:["Next is the",(0,i.jsx)(n.code,{children:"Npm install"})," command that actually populates the authors local Specification repo with the Spec-Up(-T) code."]}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, it's no different on github.com: a ",(0,i.jsx)(n.code,{children:"push"})," will invoke a github action that generates a branch called ",(0,i.jsx)(n.code,{children:"gh-pages"})," with the same files."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---1",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"Both a local and remote version of an author's specification can be generated, can be monitored and curated."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(6569).A+"",width:"1744",height:"910"})}),"\n",(0,i.jsxs)(n.p,{children:["The static site generation result in a one page ",(0,i.jsx)(n.code,{children:"index.html"})," file."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---2",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"An author can develop and test the Specification locally and then push it to production."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(9251).A+"",width:"1750",height:"1010"})}),"\n",(0,i.jsx)(n.h4,{id:"important-note",children:"Important note"}),"\n",(0,i.jsxs)(n.p,{children:["To get the github page online a few configuration steps must follow on github.com repo, branche ",(0,i.jsx)(n.code,{children:"master"})]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"Go to 'Settings' -> 'Pages' (you need administrator-rights)"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"to publish the Specification as a one pager on github.io."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(1724).A+"",width:"1588",height:"456"})}),"\n",(0,i.jsx)(n.h3,{id:"perspective-coders",children:"Perspective: Coders"}),"\n",(0,i.jsx)(n.p,{children:"Suppose DIF's Spec-Up is stable and not actively enhanced further. Spec-Up still can merge PRs from others. In time Spec-Up-T libraries will grow (second circle pair) and with this development and through merges Spec-Up can cherry pick whatever it wants to incorporate from Spec-Up-T and grow too, without diverging (third circle pair)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4606).A+"",width:"1746",height:"972"})}),"\n",(0,i.jsx)(n.p,{children:"The image below shows the github.com repo and its NPM library section op the in green, red and orange. and in below. We won\u2019t touch the red and orange sections in our repo \u2018Spec-Up-T\u2019 without making a separate branche and offer the changes as a PR to DIF."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4419).A+"",width:"349",height:"811"})}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, the ",(0,i.jsx)(n.code,{children:"Spec"})," directory regularly holds the authors' markdown, but it's crossed out because this is a configurable location."]}),"\n",(0,i.jsx)(n.h3,{id:"legend",children:"Legend"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Red: definitely do not touch anything, because of the red files and red directories are generated and some are core components"}),"\n",(0,i.jsx)(n.li,{children:"Orange: may touch, but in consultation via PRs with DIF / Daniel Buchner"}),"\n",(0,i.jsx)(n.li,{children:"Green: these are the files to freely alter under Spec-Up-T."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"In the orange sections, we could make amendments for ToIP concepts and terminology. By doing so, we can move forward without having to wait for DIF to accept or reject these changes."}),"\n",(0,i.jsx)(n.p,{children:"Other Spec-Up-based repos could come over to Spec-Up-T and pull the amendments that we've made to their repo. We\u2019ll branch off per feature. Because we stay in sync with the latest Spec-Up, a clean merge with little or no merge conflicts should be possible. Of course, for this to happen, the target repo needs to be in sync with the latest Spec-Up too."}),"\n",(0,i.jsx)(n.h3,{id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",children:"Preparatory code organization and Git configuration in current DIF Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"To have a clean start we suggest to offer a PR to Daniel Buchner. This PR doesn't change any feature nor outcome at the front-end side of a Spec-Up generated site, but only alters the code organisation. Thesse are the points of interest:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintain a Clean Division: Currently, our Node.js scripts are placed in the root directory, while client-side JavaScript and CSS have their own directory under /assets. We should aim for a similar clean separation of all Node.js (and server side code in general) for all new developments. By organizing new features and code into separate files within a dedicated directory, we can ensure that code and content is even more manageable and even better organized."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Minimize Changes to Existing Code: To facilitate smoother updates and reduce the burden of acceptance checks, it's crucial to keep modifications to existing code to a minimum. By placing new code in distinct files and directories, we allow ongoing work without significant disruption. This approach respects the existing codebase while permitting necessary extensions and bug fixes."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Exclude Generated Files from Git. In our case it is about node_modules, generated files (e.g., everything in /compiled). It should not be included in our Git repositories. These files are the result of compilation commands like ",(0,i.jsx)(n.code,{children:"$ gulp compile"})," and can be recreated from source, making their inclusion in version control redundant and cluttering."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintenance issues:"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"main and master branch?! What's the use of keeping both?"}),"\n",(0,i.jsx)(n.li,{children:".gitignore revision (fonts in ignore? other stuff in .gitignore?)"}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},9251:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1Gk-UiEA-97a120088f597f6f5f1ddb5d7772f5b8.png"},6569:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1aQg8iNC-b028d205236d10965fbcabc35d149332.png"},4419:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/Hy_mVl1rR-1a9da3ed9a251db88a872dd9f4929b21.png"},7081:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/HymBy8j4A-c9b711f6978646294903a1e0dd551303.png"},4606:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/SyxaaHsEC-d9b66475d3ca9e96adc9f581a07d0098.png"},1724:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/rJAWXLsNR-db4adf83c1c5837e170ab3af738d1e50.png"},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var i=t(6540);const o={},s=i.createContext(o);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c4a0550b.f4702d3e.js b/assets/js/c4a0550b.f4702d3e.js new file mode 100644 index 00000000..3ef063d6 --- /dev/null +++ b/assets/js/c4a0550b.f4702d3e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[509],{4028:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>r,toc:()=>d});var i=t(4848),o=t(8453);const s={sidebar_position:17},a="How it came to be",r={id:"how-it-came-to-be",title:"How it came to be",description:"The ToIP Terms extension of Spec-Up",source:"@site/docs/how-it-came-to-be.md",sourceDirName:".",slug:"/how-it-came-to-be",permalink:"/spec-up-t-website/docs/how-it-came-to-be",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/how-it-came-to-be.md",tags:[],version:"current",sidebarPosition:17,frontMatter:{sidebar_position:17},sidebar:"tutorialSidebar",previous:{title:"Spec-Up-T demo",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site"},next:{title:"Q & A",permalink:"/spec-up-t-website/docs/q-and-a"}},c={},d=[{value:"The ToIP Terms extension of Spec-Up",id:"the-toip-terms-extension-of-spec-up",level:2},{value:"What's different?",id:"whats-different",level:3},{value:"A rock and a hard place",id:"a-rock-and-a-hard-place",level:3},{value:"Versioning of terms and interactive use of specifications",id:"versioning-of-terms-and-interactive-use-of-specifications",level:3},{value:"No-go solo",id:"no-go-solo",level:3},{value:"How do we stay in sync?",id:"how-do-we-stay-in-sync",level:3},{value:"Charting territories",id:"charting-territories",level:3},{value:"Perspective: Authors",id:"perspective-authors",level:3},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this--",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---1",level:4},{value:"What's the meaning of this? ->",id:"whats-the-meaning-of-this---2",level:4},{value:"Important note",id:"important-note",level:4},{value:"Perspective: Coders",id:"perspective-coders",level:3},{value:"Legend",id:"legend",level:3},{value:"Preparatory code organization and Git configuration in current DIF Spec-Up",id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",level:3}];function l(e){const n={blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"how-it-came-to-be",children:"How it came to be"}),"\n",(0,i.jsx)(n.h2,{id:"the-toip-terms-extension-of-spec-up",children:"The ToIP Terms extension of Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"This article is meant for technical experts in Spec-Up and git."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.strong,{children:"What is Spec-Up, what is Spec-Up-T and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way?\nA brief answer to all of these questions is \u2018yes\u2019. This article elaborates on the details and comes up with an elegant, yet simple and practical, git governance proposal that will keep the ties between Spec-Up and Spec-Up-T in tact."})}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"\u201cSpec-Up is a technical specification development tool that enables you to create rich specification documents for standards bodies and engineering projects by writing in an extended version of markdown that features all the bells and whistles - for example: advanced syntax highlighting, notice blocks, complex tables, charts, UML diagrams, and more.\u201d\nBy: Spec-Up creator Daniel Buchner, at Decentralised Identity Foundation (DIF)."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"Spec-Up is a great tool for creating online standardization specifications. We use it a lot at TrustoverIP. Recently, we also started contributing to DIF\u2019s Spec-Up code."}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we support the original objective of DIF with Spec-Up. Spec-Up, as it is at present, gives us a base that we want to stay in sync with. Why do we want to merge changes to and fro DIF's spec-up?"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"To acknowledge the great work accomplished by DIF"}),"\n",(0,i.jsx)(n.li,{children:"Support a common specification tool in the SSI field that overarches the active umbrella organisations"}),"\n",(0,i.jsx)(n.li,{children:"last but not least: to combine current and future efforts."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"whats-different",children:"What's different?"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we do more with concepts and terminology than has been foreseen with Spec-Up. For example: versioning of individual terms, and versioning of who references them and when, has been proven a key to success of building consensus within ToIP."}),"\n",(0,i.jsx)(n.p,{children:"To offer ToIP-specific Spec-Up functionality we need to extent the code. Happily, we are able to extend Spec-Up with specific front-end and back-end functionality. As we did before, we could offer those extensions as a PR to DIF\u2019s Spec-Up. In practise this means: and ask Daniel Buchner to have a look at it and ask him to consider merging the new code into the main code repository of Spec-Up."}),"\n",(0,i.jsx)(n.h3,{id:"a-rock-and-a-hard-place",children:"A rock and a hard place"}),"\n",(0,i.jsxs)(n.p,{children:["What could be problematic for ToIP about the approach to present PRs regarding our ",(0,i.jsx)(n.em,{children:"specific"})," ToIP code to DIF's Spec-Up:"]}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"We put Daniel Buchner / DIF on the critical path for ToIP development"}),"\n",(0,i.jsx)(n.li,{children:"We ask DIF to accept bolt-ons to a lean and mean Spec-Up"}),"\n",(0,i.jsx)(n.li,{children:"We trigger discussions about objectives of Spec-Up, where we want to implement Spec-Up right away.\nThis leaves us between a rock and a hard place if we were to proceed as before."}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"versioning-of-terms-and-interactive-use-of-specifications",children:"Versioning of terms and interactive use of specifications"}),"\n",(0,i.jsx)(n.p,{children:"At ToIP we have a need for a Spec-Up tool that has a slightly different angle to static site generation for specification-documents:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsx)(n.li,{children:"because we have a ToIP-specific fine-grained view on concepts and terminology."}),"\n",(0,i.jsx)(n.li,{children:"we might want to have a few front-end amendments that would not match the lean and mean Spec-Up at DIF with the vision to have a compact simple solution for standards documents."}),"\n",(0,i.jsxs)(n.li,{children:["We might want to extend the layout capabilities to adhere to standards of specific target audiences.\nThe last reason is that we want to move faster with as little \u201cdesks to go for a stamp\u201d as possible.\nWe call this extended Spec-Up ",(0,i.jsx)(n.em,{children:"Spec-Up-T"}),", where \u2019T\u2019 can both cover - or refer to - \u2018Terms\u2019 and \u2018ToIP\u2019."]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"no-go-solo",children:"No-go solo"}),"\n",(0,i.jsxs)(n.p,{children:["What if we were to declare a part of the code in the DIF Spec-Up repository a ",(0,i.jsx)(n.em,{children:"no-go area"}),"? More specifically, within a common shared area we only change code under consensus by offering PRs to be accepted and merged by DIF. That would make coding easier and offer a clear division in feature sets of Spec-Up and Spec-Up-T."]}),"\n",(0,i.jsx)(n.p,{children:"Due to the reasons listed above, we need to partly develop solo in a fork (Spec-Up-T), and then we could offer our work to DIF. If they merge our code in their repo, that\u2019d be great because it would confirm consensus about objectives behind Spec-Up. But this mutual merge is optional for DIF."}),"\n",(0,i.jsx)(n.h3,{id:"how-do-we-stay-in-sync",children:"How do we stay in sync?"}),"\n",(0,i.jsx)(n.p,{children:'We propose a "bi-directional sync" or "mutual synchronization" model. In this model, both repositories are equally important, and changes are synced between them at will to ensure they both contain the same information or updates.'}),"\n",(0,i.jsx)(n.h3,{id:"charting-territories",children:"Charting territories"}),"\n",(0,i.jsx)(n.p,{children:"For clarity, there are three main perspectives on Spec-Up(-T) publicly AND on your local computer:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Authors"})," look at ready-to-use Spec-Up github.com version (after running Starter-pack)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Coders"})," look at the NPM Spec-Up libraries"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.strong,{children:"Users"})," see the generated end-product on github.io (index.html)"]}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"perspective-authors",children:"Perspective: Authors"}),"\n",(0,i.jsxs)(n.p,{children:["Authors of a new Specification start with an empty directory on their local machine. After the command ",(0,i.jsx)(n.code,{children:"npm install spec-up-T"})," the spec directory and all the files mentioned will be present. The grey files are not to be touched because they are generated results. The green files can be altered to fill and configure the new Specification. A Spec-Up-T install will typically include all DIF Spec-Up code."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this--",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"After this an author can start filling the project, and configuring Spec-Up(-T)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(7081).A+"",width:"1730",height:"878"})}),"\n",(0,i.jsxs)(n.p,{children:["Next is the",(0,i.jsx)(n.code,{children:"Npm install"})," command that actually populates the authors local Specification repo with the Spec-Up(-T) code."]}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, it's no different on github.com: a ",(0,i.jsx)(n.code,{children:"push"})," will invoke a github action that generates a branch called ",(0,i.jsx)(n.code,{children:"gh-pages"})," with the same files."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---1",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"Both a local and remote version of an author's specification can be generated, can be monitored and curated."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(6569).A+"",width:"1744",height:"910"})}),"\n",(0,i.jsxs)(n.p,{children:["The static site generation result in a one page ",(0,i.jsx)(n.code,{children:"index.html"})," file."]}),"\n",(0,i.jsx)(n.h4,{id:"whats-the-meaning-of-this---2",children:"What's the meaning of this? ->"}),"\n",(0,i.jsx)(n.p,{children:"An author can develop and test the Specification locally and then push it to production."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(9251).A+"",width:"1750",height:"1010"})}),"\n",(0,i.jsx)(n.h4,{id:"important-note",children:"Important note"}),"\n",(0,i.jsxs)(n.p,{children:["To get the github page online a few configuration steps must follow on github.com repo, branche ",(0,i.jsx)(n.code,{children:"master"})]}),"\n",(0,i.jsxs)(n.blockquote,{children:["\n",(0,i.jsx)(n.p,{children:"Go to 'Settings' -> 'Pages' (you need administrator-rights)"}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"to publish the Specification as a one pager on github.io."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(1724).A+"",width:"1588",height:"456"})}),"\n",(0,i.jsx)(n.h3,{id:"perspective-coders",children:"Perspective: Coders"}),"\n",(0,i.jsx)(n.p,{children:"Suppose DIF's Spec-Up is stable and not actively enhanced further. Spec-Up still can merge PRs from others. In time Spec-Up-T libraries will grow (second circle pair) and with this development and through merges Spec-Up can cherry pick whatever it wants to incorporate from Spec-Up-T and grow too, without diverging (third circle pair)."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4606).A+"",width:"1746",height:"972"})}),"\n",(0,i.jsx)(n.p,{children:"The image below shows the github.com repo and its NPM library section op the in green, red and orange. and in below. We won\u2019t touch the red and orange sections in our repo \u2018Spec-Up-T\u2019 without making a separate branche and offer the changes as a PR to DIF."}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.img,{alt:"image",src:t(4419).A+"",width:"349",height:"811"})}),"\n",(0,i.jsxs)(n.p,{children:["Mind you, the ",(0,i.jsx)(n.code,{children:"Spec"})," directory regularly holds the authors' markdown, but it's crossed out because this is a configurable location."]}),"\n",(0,i.jsx)(n.h3,{id:"legend",children:"Legend"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Red: definitely do not touch anything, because of the red files and red directories are generated and some are core components"}),"\n",(0,i.jsx)(n.li,{children:"Orange: may touch, but in consultation via PRs with DIF / Daniel Buchner"}),"\n",(0,i.jsx)(n.li,{children:"Green: these are the files to freely alter under Spec-Up-T."}),"\n"]}),"\n",(0,i.jsx)(n.p,{children:"In the orange sections, we could make amendments for ToIP concepts and terminology. By doing so, we can move forward without having to wait for DIF to accept or reject these changes."}),"\n",(0,i.jsx)(n.p,{children:"Other Spec-Up-based repos could come over to Spec-Up-T and pull the amendments that we've made to their repo. We\u2019ll branch off per feature. Because we stay in sync with the latest Spec-Up, a clean merge with little or no merge conflicts should be possible. Of course, for this to happen, the target repo needs to be in sync with the latest Spec-Up too."}),"\n",(0,i.jsx)(n.h3,{id:"preparatory-code-organization-and-git-configuration-in-current-dif-spec-up",children:"Preparatory code organization and Git configuration in current DIF Spec-Up"}),"\n",(0,i.jsx)(n.p,{children:"To have a clean start we suggest to offer a PR to Daniel Buchner. This PR doesn't change any feature nor outcome at the front-end side of a Spec-Up generated site, but only alters the code organisation. Thesse are the points of interest:"}),"\n",(0,i.jsxs)(n.ol,{children:["\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintain a Clean Division: Currently, our Node.js scripts are placed in the root directory, while client-side JavaScript and CSS have their own directory under /assets. We should aim for a similar clean separation of all Node.js (and server side code in general) for all new developments. By organizing new features and code into separate files within a dedicated directory, we can ensure that code and content is even more manageable and even better organized."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Minimize Changes to Existing Code: To facilitate smoother updates and reduce the burden of acceptance checks, it's crucial to keep modifications to existing code to a minimum. By placing new code in distinct files and directories, we allow ongoing work without significant disruption. This approach respects the existing codebase while permitting necessary extensions and bug fixes."}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsxs)(n.p,{children:["Exclude Generated Files from Git. In our case it is about node_modules, generated files (e.g., everything in /compiled). It should not be included in our Git repositories. These files are the result of compilation commands like ",(0,i.jsx)(n.code,{children:"$ gulp compile"})," and can be recreated from source, making their inclusion in version control redundant and cluttering."]}),"\n"]}),"\n",(0,i.jsxs)(n.li,{children:["\n",(0,i.jsx)(n.p,{children:"Maintenance issues:"}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"main and master branch?! What's the use of keeping both?"}),"\n",(0,i.jsx)(n.li,{children:".gitignore revision (fonts in ignore? other stuff in .gitignore?)"}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},9251:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1Gk-UiEA-97a120088f597f6f5f1ddb5d7772f5b8.png"},6569:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/H1aQg8iNC-b028d205236d10965fbcabc35d149332.png"},4419:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/Hy_mVl1rR-1a9da3ed9a251db88a872dd9f4929b21.png"},7081:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/HymBy8j4A-c9b711f6978646294903a1e0dd551303.png"},4606:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/SyxaaHsEC-d9b66475d3ca9e96adc9f581a07d0098.png"},1724:(e,n,t)=>{t.d(n,{A:()=>i});const i=t.p+"assets/images/rJAWXLsNR-db4adf83c1c5837e170ab3af738d1e50.png"},8453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>r});var i=t(6540);const o={},s=i.createContext(o);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e0c4e08d.ad62afba.js b/assets/js/e0c4e08d.ad62afba.js deleted file mode 100644 index a511127c..00000000 --- a/assets/js/e0c4e08d.ad62afba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[157],{3362:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>h,contentTitle:()=>d,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var o=t(4848),i=t(8453),s=t(6540);const r=e=>{let{src:n,width:t}=e;const i=(0,s.useRef)(null);return(0,o.jsx)("iframe",{ref:i,src:n,width:t||"100%",style:{border:"none",width:t||"100%",height:"auto"},onLoad:()=>{try{const e=i.current,n=e.contentDocument.body,t=e.contentDocument.documentElement,o=Math.max(n.scrollHeight,n.offsetHeight,t.clientHeight,t.scrollHeight,t.offsetHeight);e.style.height=`${o}px`}catch(e){console.error("Error accessing iframe content:",e)}}})},a={sidebar_position:15},d="Spec-Up-T demo site",c={id:"spec-up-t-demo-site",title:"Spec-Up-T demo site",description:"The Demo",source:"@site/docs/spec-up-t-demo-site.mdx",sourceDirName:".",slug:"/spec-up-t-demo-site",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/spec-up-t-demo-site.mdx",tags:[],version:"current",sidebarPosition:15,frontMatter:{sidebar_position:15},sidebar:"tutorialSidebar",previous:{title:"Readers Guide",permalink:"/spec-up-t-website/docs/readers-guide/introduction"},next:{title:"Q & A",permalink:"/spec-up-t-website/docs/q-and-a"}},h={},l=[{value:"The Demo",id:"the-demo",level:2},{value:"Begin of the Spec-Up-T demo:",id:"begin-of-the-spec-up-t-demo",level:3},{value:"End of the Spec-Up-T demo",id:"end-of-the-spec-up-t-demo",level:3},{value:"The markdown",id:"the-markdown",level:2}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"spec-up-t-demo-site",children:"Spec-Up-T demo site"}),"\n",(0,o.jsx)(n.h2,{id:"the-demo",children:"The Demo"}),"\n",(0,o.jsxs)(n.p,{children:["Below is a demo of the Spec-Up-T website in an iFrame. You can also open the Spec-Up-T website in a standalone window by clicking ",(0,o.jsx)(n.a,{href:"https://blockchainbird.github.io/spec-up-t-website/spec-up-t-demo/docs/index.html",children:"here"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"This demo showcases how a Spec-Up-T specification (a single index.html file) can be integrated into other systems."}),"\n",(0,o.jsx)(n.p,{children:"In this Spec-Up-T demo, you will find:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Examples of definitions and references"}),"\n",(0,o.jsx)(n.li,{children:"Examples of various styles that can be used in Spec-Up-T"}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Below is the Spec-Up-T website in an iFrame. Open the Spec-Up-T website in a standalone window by clicking ",(0,o.jsx)(n.a,{href:"https://blockchainbird.github.io/spec-up-t-website/spec-up-t-demo/docs/index.html",children:"here"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"begin-of-the-spec-up-t-demo",children:"Begin of the Spec-Up-T demo:"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(r,{src:"/spec-up-t-website/spec-up-t-demo/docs/index.html",width:"100%"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"end-of-the-spec-up-t-demo",children:"End of the Spec-Up-T demo"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"the-markdown",children:"The markdown"}),"\n",(0,o.jsx)(n.p,{children:"Below is the markdown of the \u201cDemo of example markup in Spec-Up-T and Markdown\u201d section of demo Spec-Up-T above:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'## Demo of example markup in Spec-Up-T and Markdown\n\n### Blockquote\n\n> To be, or not to be, that is the question:\nWhether \'tis nobler in the mind to suffer\nThe slings and arrows of outrageous fortune,\nOr to take arms against a sea of troubles\nAnd by opposing end them. To die\u2014to sleep,\nNo more;\n\n### Notices\n\n
\n::: note Basic Note\n  Check this out.\n:::\n
\n\n::: note Basic Note\n Check this out.\n:::\n\n::: note\n Here\'s another.\n:::\n\n::: note\n And one more!\n:::\n\n::: note Basic Note\n One last note!!!\n:::\n\n
\n::: issue Issue Notice\n  I take issue with that, kind sir.\n:::\n
\n\n::: issue Issue Notice\n I take issue with that, kind sir.\n:::\n\n
\n::: warning Warning Notice\n  Houston, I think we have a problem\n:::\n
\n\n::: warning Warning Notice\n Houston, I think we have a problem\n:::\n\n
\n::: todo Really Important\n  Get this done!\n:::\n
\n\n::: todo Really Important\n Get this done!\n:::\n\n
\n::: example Code Example\n  Put your code block here\n:::\n
\n\n::: example Code Example\n\n\\`\\`\\`json\n// Some comment in JSON\n{\n "foo": "bar",\n "baz": 2\n}\n\\`\\`\\`\n\n:::\n\n### Content Insertion\n\nUse the following format to pull in content from other files in your project:\n\n
\nThis text has been inserted here from another file: [[insert: assets/test.text]]\n
\n\nThis text has been inserted here from another file: [[insert: assets/test.text]]\n\nYou can even insert content within more complex blocks, like the JSON object below which is being pulled in and rendered in a syntax-highlighted example block:\n
\n::: example Code Example\n\\`\\`\\`json\n[[insert: assets/test.json]]\n\\`\\`\\`\n:::\n
\n\n::: example Code Example\n\n\\`\\`\\`json\n[[insert: assets/test.json]]\n\\`\\`\\`\n\n:::\n\n### Tables\n\n
\nStage | Direct Products | ATP Yields\n----: | --------------: | ---------:\nGlycolysis | 2 ATP ||\n^^ | 2 NADH | 3--5 ATP |\nPyruvaye oxidation | 2 NADH | 5 ATP |\nCitric acid cycle | 2 ATP ||\n^^ | 6 NADH | 15 ATP |\n^^ | 2 FADH2 | 3 ATP |\n**30--32** ATP |||\n[Net ATP yields per hexose]\n
\n\nStage | Direct Products | ATP Yields\n----: | --------------: | ---------:\nGlycolysis | 2 ATP ||\n^^ | 2 NADH | 3--5 ATP |\nPyruvaye oxidation | 2 NADH | 5 ATP |\nCitric acid cycle | 2 ATP ||\n^^ | 6 NADH | 15 ATP |\n^^ | 2 FADH2 | 3 ATP |\n**30--32** ATP |||\n[Net ATP yields per hexose]\n\n
\n|--|--|--|--|--|--|--|--|\n|\u265c|  |\u265d|\u265b|\u265a|\u265d|\u265e|\u265c|\n|  |\u265f|\u265f|\u265f|  |\u265f|\u265f|\u265f|\n|\u265f|  |\u265e|  |  |  |  | |\n|  |\u2657|  |  |\u265f|  |  | |\n|  |  |  |  |\u2659|  |  | |\n|  |  |  |  |  |\u2658|  | |\n|\u2659|\u2659|\u2659|\u2659|  |\u2659|\u2659|\u2659|\n|\u2656|\u2658|\u2657|\u2655|\u2654|  |  |\u2656|\n
\n\n|--|--|--|--|--|--|--|--|\n|\u265c| |\u265d|\u265b|\u265a|\u265d|\u265e|\u265c |\n| |\u265f|\u265f|\u265f| |\u265f|\u265f|\u265f |\n|\u265f| |\u265e| | | | | |\n| |\u2657| | |\u265f| | | |\n| | | | |\u2659| | | |\n| | | | | |\u2658| | |\n|\u2659|\u2659|\u2659|\u2659| |\u2659|\u2659|\u2659 |\n|\u2656|\u2658|\u2657|\u2655|\u2654| | |\u2656 |\n\n### Sequence Diagrams\n\n
\n\\`\\`\\`mermaid\nsequenceDiagram\n  Alice ->> Bob: Hello Bob, how are you?\n  Bob--\x3e>John: How about you John?\n  Bob--x Alice: I am good thanks!\n  Bob-x John: I am good thanks!\n  Note right of John: Bob thinks a long
long time, so long
that the text does
not fit on a row.\n\n  Bob--\x3eAlice: Checking with John...\n  Alice->John: Yes... John, how are you?\n\\`\\`\\`\n
\n\n\\`\\`\\`mermaid\nsequenceDiagram\n Alice ->> Bob: Hello Bob, how are you?\n Bob--\x3e>John: How about you John?\n Bob--x Alice: I am good thanks!\n Bob-x John: I am good thanks!\n Note right of John: Bob thinks a long
long time, so long
that the text does
not fit on a row.\n\n Bob--\x3eAlice: Checking with John...\n Alice->John: Yes... John, how are you?\n\\`\\`\\`\n\n### Flows\n\n
\n\\`\\`\\`mermaid\ngraph TD\n  A[Start] --\x3e B{Is it?}\n  B --\x3e|Yes| C[OK]\n  C --\x3e D[Rethink]\n  D --\x3e B\n  B --\x3e|No| E[End]\n\\`\\`\\`\n
\n\n\\`\\`\\`mermaid\ngraph TD\n A[Start] --\x3e B{Is it?}\n B --\x3e|Yes| C[OK]\n C --\x3e D[Rethink]\n D --\x3e B\n B --\x3e|No| E[End]\n\\`\\`\\`\n\n### Charts\n\n
\n\\`\\`\\`chart\n{\n  "type": "pie",\n  "data": {\n    "labels": [\n      "Red",\n      "Blue",\n      "Yellow"\n    ],\n    "datasets": [\n      {\n        "data": [\n          300,\n          50,\n          100\n        ],\n        "backgroundColor": [\n          "#FF6384",\n          "#36A2EB",\n          "#FFCE56"\n        ],\n        "hoverBackgroundColor": [\n          "#FF6384",\n          "#36A2EB",\n          "#FFCE56"\n        ]\n      }\n    ]\n  }\n}\n\\`\\`\\`\n
\n\n\\`\\`\\`chart\n{\n "type": "pie",\n "data": {\n "labels": [\n "Red",\n "Blue",\n "Yellow"\n ],\n "datasets": [\n {\n "data": [\n 300,\n 50,\n 100\n ],\n "backgroundColor": [\n "#FF6384",\n "#36A2EB",\n "#FFCE56"\n ],\n "hoverBackgroundColor": [\n "#FF6384",\n "#36A2EB",\n "#FFCE56"\n ]\n }\n ]\n }\n}\n\\`\\`\\`\n\n### Syntax Highlighting\n\n
\n\\`\\`\\`json\n{\n  "@context": "https://www.w3.org/ns/did/v1",\n  "id": "did:example:123456789abcdefghi",\n  "authentication": [{\n    "id": "did:example:123456789abcdefghi#keys-1",\n    "type": "RsaVerificationKey2018",\n    "controller": "did:example:123456789abcdefghi",\n    "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\\r\\n"\n  }],\n  "service": [{\n    "id":"did:example:123456789abcdefghi#vcs",\n    "type": "VerifiableCredentialService",\n    "serviceEndpoint": "https://example.com/vc/"\n  }]\n}\n\\`\\`\\`\n
\n\n\\`\\`\\`json\n{\n "@context": "https://www.w3.org/ns/did/v1",\n "id": "did:example:123456789abcdefghi",\n "authentication": [{ \n "id": "did:example:123456789abcdefghi#keys-1",\n "type": "RsaVerificationKey2018",\n "controller": "did:example:123456789abcdefghi",\n "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\\r\\n"\n }],\n "service": [{\n "id":"did:example:123456789abcdefghi#vcs",\n "type": "VerifiableCredentialService",\n "serviceEndpoint": "https://example.com/vc/"\n }]\n}\n\\`\\`\\`\n\n### TeX Math Equations\n\nWhen the `katex` option is enabled, the KaTeX math engine is used for TeX rendering. You can find a list of supported features and examples here: .\n\n$$\\begin{pmatrix}x_2 \\\\ y_2 \\end{pmatrix} =\n\\begin{pmatrix} A & B \\\\ C & D \\end{pmatrix}\\cdot\n\\begin{pmatrix} x_1 \\\\ y_1 \\end{pmatrix}$$\n\n$$\\def\\arraystretch{1.5}\n \\begin{array}{c:c:c}\n a & b & c \\\\ \\hline\n d & e & f \\\\\n \\hdashline\n g & h & i\n\\end{array}$$\n\n$$\n\\underbrace{a+b+c}_{\\text{Note: such math, much wow.}}\n$$\n\n### Tab Panels\n\n\n \n\n
\n\n\\`\\`\\`json\n{\n "foo": "foo",\n "baz": 1\n}\n\\`\\`\\`\n\n
\n
\n\n\\`\\`\\`json\n{\n "foo": "bar",\n "baz": 2\n}\n\\`\\`\\`\n\n
\n\n\n### Fancy Links\n\nSpec-Up automatically upgrades the links of certain sites, like GitHub. GitHub is the only supported site with Fancy Links right now, but we\'ll be adding more as we go.\n\n### GitHub\n\n- **Issues**\n - Source: `https://github.com/decentralized-identity/presentation-exchange/issues/119`\n - Render: https://github.com/decentralized-identity/presentation-exchange/issues/119\n- **Pull Requests**\n - Source: `https://github.com/decentralized-identity/sidetree/pull/863`\n - Render: https://github.com/decentralized-identity/sidetree/pull/863\n- **Releases**\n - Source: `https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1`\n - Render: https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1\n- **Projects**\n - Source: `https://github.com/decentralized-identity/sidetree/projects/1`\n - Render: https://github.com/decentralized-identity/sidetree/projects/1\n\n'})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var o=t(6540);const i={},s=o.createContext(i);function r(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e0c4e08d.c309d43b.js b/assets/js/e0c4e08d.c309d43b.js new file mode 100644 index 00000000..4f464e0e --- /dev/null +++ b/assets/js/e0c4e08d.c309d43b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[157],{3362:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>h,contentTitle:()=>d,default:()=>u,frontMatter:()=>a,metadata:()=>c,toc:()=>l});var o=t(4848),i=t(8453),s=t(6540);const r=e=>{let{src:n,width:t}=e;const i=(0,s.useRef)(null);return(0,o.jsx)("iframe",{ref:i,src:n,width:t||"100%",style:{border:"none",width:t||"100%",height:"auto"},onLoad:()=>{try{const e=i.current,n=e.contentDocument.body,t=e.contentDocument.documentElement,o=Math.max(n.scrollHeight,n.offsetHeight,t.clientHeight,t.scrollHeight,t.offsetHeight);e.style.height=`${o}px`}catch(e){console.error("Error accessing iframe content:",e)}}})},a={sidebar_position:16},d="Spec-Up-T demo",c={id:"spec-up-t-demo-site",title:"Spec-Up-T demo",description:"The Demo",source:"@site/docs/spec-up-t-demo-site.mdx",sourceDirName:".",slug:"/spec-up-t-demo-site",permalink:"/spec-up-t-website/docs/spec-up-t-demo-site",draft:!1,unlisted:!1,editUrl:"https://github.com/blockchainbird/spec-up-t-website/tree/main/docs/spec-up-t-demo-site.mdx",tags:[],version:"current",sidebarPosition:16,frontMatter:{sidebar_position:16},sidebar:"tutorialSidebar",previous:{title:"Developers Guide",permalink:"/spec-up-t-website/docs/developers-guide"},next:{title:"How it came to be",permalink:"/spec-up-t-website/docs/how-it-came-to-be"}},h={},l=[{value:"The Demo",id:"the-demo",level:2},{value:"Begin of the Spec-Up-T demo:",id:"begin-of-the-spec-up-t-demo",level:3},{value:"End of the Spec-Up-T demo",id:"end-of-the-spec-up-t-demo",level:3},{value:"The markdown",id:"the-markdown",level:2}];function p(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",hr:"hr",li:"li",ol:"ol",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"spec-up-t-demo",children:"Spec-Up-T demo"}),"\n",(0,o.jsx)(n.h2,{id:"the-demo",children:"The Demo"}),"\n",(0,o.jsxs)(n.p,{children:["Below is a demo of the Spec-Up-T website in an iFrame. You can also open the Spec-Up-T website in a standalone window by clicking ",(0,o.jsx)(n.a,{href:"https://blockchainbird.github.io/spec-up-t-website/spec-up-t-demo/docs/index.html",children:"here"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"This demo showcases how a Spec-Up-T specification (a single index.html file) can be integrated into other systems."}),"\n",(0,o.jsx)(n.p,{children:"In this Spec-Up-T demo, you will find:"}),"\n",(0,o.jsxs)(n.ol,{children:["\n",(0,o.jsx)(n.li,{children:"Examples of definitions and references"}),"\n",(0,o.jsx)(n.li,{children:"Examples of various styles that can be used in Spec-Up-T"}),"\n"]}),"\n",(0,o.jsxs)(n.p,{children:["Below is the Spec-Up-T website in an iFrame. Open the Spec-Up-T website in a standalone window by clicking ",(0,o.jsx)(n.a,{href:"https://blockchainbird.github.io/spec-up-t-website/spec-up-t-demo/docs/index.html",children:"here"}),"."]}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"begin-of-the-spec-up-t-demo",children:"Begin of the Spec-Up-T demo:"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(r,{src:"/spec-up-t-website/spec-up-t-demo/docs/index.html",width:"100%"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h3,{id:"end-of-the-spec-up-t-demo",children:"End of the Spec-Up-T demo"}),"\n",(0,o.jsx)(n.hr,{}),"\n",(0,o.jsx)(n.h2,{id:"the-markdown",children:"The markdown"}),"\n",(0,o.jsx)(n.p,{children:"Below is the markdown of the \u201cDemo of example markup in Spec-Up-T and Markdown\u201d section of demo Spec-Up-T above:"}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{children:'## Demo of example markup in Spec-Up-T and Markdown\n\n### Blockquote\n\n> To be, or not to be, that is the question:\nWhether \'tis nobler in the mind to suffer\nThe slings and arrows of outrageous fortune,\nOr to take arms against a sea of troubles\nAnd by opposing end them. To die\u2014to sleep,\nNo more;\n\n### Notices\n\n
\n::: note Basic Note\n  Check this out.\n:::\n
\n\n::: note Basic Note\n Check this out.\n:::\n\n::: note\n Here\'s another.\n:::\n\n::: note\n And one more!\n:::\n\n::: note Basic Note\n One last note!!!\n:::\n\n
\n::: issue Issue Notice\n  I take issue with that, kind sir.\n:::\n
\n\n::: issue Issue Notice\n I take issue with that, kind sir.\n:::\n\n
\n::: warning Warning Notice\n  Houston, I think we have a problem\n:::\n
\n\n::: warning Warning Notice\n Houston, I think we have a problem\n:::\n\n
\n::: todo Really Important\n  Get this done!\n:::\n
\n\n::: todo Really Important\n Get this done!\n:::\n\n
\n::: example Code Example\n  Put your code block here\n:::\n
\n\n::: example Code Example\n\n\\`\\`\\`json\n// Some comment in JSON\n{\n "foo": "bar",\n "baz": 2\n}\n\\`\\`\\`\n\n:::\n\n### Content Insertion\n\nUse the following format to pull in content from other files in your project:\n\n
\nThis text has been inserted here from another file: [[insert: assets/test.text]]\n
\n\nThis text has been inserted here from another file: [[insert: assets/test.text]]\n\nYou can even insert content within more complex blocks, like the JSON object below which is being pulled in and rendered in a syntax-highlighted example block:\n
\n::: example Code Example\n\\`\\`\\`json\n[[insert: assets/test.json]]\n\\`\\`\\`\n:::\n
\n\n::: example Code Example\n\n\\`\\`\\`json\n[[insert: assets/test.json]]\n\\`\\`\\`\n\n:::\n\n### Tables\n\n
\nStage | Direct Products | ATP Yields\n----: | --------------: | ---------:\nGlycolysis | 2 ATP ||\n^^ | 2 NADH | 3--5 ATP |\nPyruvaye oxidation | 2 NADH | 5 ATP |\nCitric acid cycle | 2 ATP ||\n^^ | 6 NADH | 15 ATP |\n^^ | 2 FADH2 | 3 ATP |\n**30--32** ATP |||\n[Net ATP yields per hexose]\n
\n\nStage | Direct Products | ATP Yields\n----: | --------------: | ---------:\nGlycolysis | 2 ATP ||\n^^ | 2 NADH | 3--5 ATP |\nPyruvaye oxidation | 2 NADH | 5 ATP |\nCitric acid cycle | 2 ATP ||\n^^ | 6 NADH | 15 ATP |\n^^ | 2 FADH2 | 3 ATP |\n**30--32** ATP |||\n[Net ATP yields per hexose]\n\n
\n|--|--|--|--|--|--|--|--|\n|\u265c|  |\u265d|\u265b|\u265a|\u265d|\u265e|\u265c|\n|  |\u265f|\u265f|\u265f|  |\u265f|\u265f|\u265f|\n|\u265f|  |\u265e|  |  |  |  | |\n|  |\u2657|  |  |\u265f|  |  | |\n|  |  |  |  |\u2659|  |  | |\n|  |  |  |  |  |\u2658|  | |\n|\u2659|\u2659|\u2659|\u2659|  |\u2659|\u2659|\u2659|\n|\u2656|\u2658|\u2657|\u2655|\u2654|  |  |\u2656|\n
\n\n|--|--|--|--|--|--|--|--|\n|\u265c| |\u265d|\u265b|\u265a|\u265d|\u265e|\u265c |\n| |\u265f|\u265f|\u265f| |\u265f|\u265f|\u265f |\n|\u265f| |\u265e| | | | | |\n| |\u2657| | |\u265f| | | |\n| | | | |\u2659| | | |\n| | | | | |\u2658| | |\n|\u2659|\u2659|\u2659|\u2659| |\u2659|\u2659|\u2659 |\n|\u2656|\u2658|\u2657|\u2655|\u2654| | |\u2656 |\n\n### Sequence Diagrams\n\n
\n\\`\\`\\`mermaid\nsequenceDiagram\n  Alice ->> Bob: Hello Bob, how are you?\n  Bob--\x3e>John: How about you John?\n  Bob--x Alice: I am good thanks!\n  Bob-x John: I am good thanks!\n  Note right of John: Bob thinks a long
long time, so long
that the text does
not fit on a row.\n\n  Bob--\x3eAlice: Checking with John...\n  Alice->John: Yes... John, how are you?\n\\`\\`\\`\n
\n\n\\`\\`\\`mermaid\nsequenceDiagram\n Alice ->> Bob: Hello Bob, how are you?\n Bob--\x3e>John: How about you John?\n Bob--x Alice: I am good thanks!\n Bob-x John: I am good thanks!\n Note right of John: Bob thinks a long
long time, so long
that the text does
not fit on a row.\n\n Bob--\x3eAlice: Checking with John...\n Alice->John: Yes... John, how are you?\n\\`\\`\\`\n\n### Flows\n\n
\n\\`\\`\\`mermaid\ngraph TD\n  A[Start] --\x3e B{Is it?}\n  B --\x3e|Yes| C[OK]\n  C --\x3e D[Rethink]\n  D --\x3e B\n  B --\x3e|No| E[End]\n\\`\\`\\`\n
\n\n\\`\\`\\`mermaid\ngraph TD\n A[Start] --\x3e B{Is it?}\n B --\x3e|Yes| C[OK]\n C --\x3e D[Rethink]\n D --\x3e B\n B --\x3e|No| E[End]\n\\`\\`\\`\n\n### Charts\n\n
\n\\`\\`\\`chart\n{\n  "type": "pie",\n  "data": {\n    "labels": [\n      "Red",\n      "Blue",\n      "Yellow"\n    ],\n    "datasets": [\n      {\n        "data": [\n          300,\n          50,\n          100\n        ],\n        "backgroundColor": [\n          "#FF6384",\n          "#36A2EB",\n          "#FFCE56"\n        ],\n        "hoverBackgroundColor": [\n          "#FF6384",\n          "#36A2EB",\n          "#FFCE56"\n        ]\n      }\n    ]\n  }\n}\n\\`\\`\\`\n
\n\n\\`\\`\\`chart\n{\n "type": "pie",\n "data": {\n "labels": [\n "Red",\n "Blue",\n "Yellow"\n ],\n "datasets": [\n {\n "data": [\n 300,\n 50,\n 100\n ],\n "backgroundColor": [\n "#FF6384",\n "#36A2EB",\n "#FFCE56"\n ],\n "hoverBackgroundColor": [\n "#FF6384",\n "#36A2EB",\n "#FFCE56"\n ]\n }\n ]\n }\n}\n\\`\\`\\`\n\n### Syntax Highlighting\n\n
\n\\`\\`\\`json\n{\n  "@context": "https://www.w3.org/ns/did/v1",\n  "id": "did:example:123456789abcdefghi",\n  "authentication": [{\n    "id": "did:example:123456789abcdefghi#keys-1",\n    "type": "RsaVerificationKey2018",\n    "controller": "did:example:123456789abcdefghi",\n    "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\\r\\n"\n  }],\n  "service": [{\n    "id":"did:example:123456789abcdefghi#vcs",\n    "type": "VerifiableCredentialService",\n    "serviceEndpoint": "https://example.com/vc/"\n  }]\n}\n\\`\\`\\`\n
\n\n\\`\\`\\`json\n{\n "@context": "https://www.w3.org/ns/did/v1",\n "id": "did:example:123456789abcdefghi",\n "authentication": [{ \n "id": "did:example:123456789abcdefghi#keys-1",\n "type": "RsaVerificationKey2018",\n "controller": "did:example:123456789abcdefghi",\n "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\\r\\n"\n }],\n "service": [{\n "id":"did:example:123456789abcdefghi#vcs",\n "type": "VerifiableCredentialService",\n "serviceEndpoint": "https://example.com/vc/"\n }]\n}\n\\`\\`\\`\n\n### TeX Math Equations\n\nWhen the `katex` option is enabled, the KaTeX math engine is used for TeX rendering. You can find a list of supported features and examples here: .\n\n$$\\begin{pmatrix}x_2 \\\\ y_2 \\end{pmatrix} =\n\\begin{pmatrix} A & B \\\\ C & D \\end{pmatrix}\\cdot\n\\begin{pmatrix} x_1 \\\\ y_1 \\end{pmatrix}$$\n\n$$\\def\\arraystretch{1.5}\n \\begin{array}{c:c:c}\n a & b & c \\\\ \\hline\n d & e & f \\\\\n \\hdashline\n g & h & i\n\\end{array}$$\n\n$$\n\\underbrace{a+b+c}_{\\text{Note: such math, much wow.}}\n$$\n\n### Tab Panels\n\n\n \n\n
\n\n\\`\\`\\`json\n{\n "foo": "foo",\n "baz": 1\n}\n\\`\\`\\`\n\n
\n
\n\n\\`\\`\\`json\n{\n "foo": "bar",\n "baz": 2\n}\n\\`\\`\\`\n\n
\n\n\n### Fancy Links\n\nSpec-Up automatically upgrades the links of certain sites, like GitHub. GitHub is the only supported site with Fancy Links right now, but we\'ll be adding more as we go.\n\n### GitHub\n\n- **Issues**\n - Source: `https://github.com/decentralized-identity/presentation-exchange/issues/119`\n - Render: https://github.com/decentralized-identity/presentation-exchange/issues/119\n- **Pull Requests**\n - Source: `https://github.com/decentralized-identity/sidetree/pull/863`\n - Render: https://github.com/decentralized-identity/sidetree/pull/863\n- **Releases**\n - Source: `https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1`\n - Render: https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1\n- **Projects**\n - Source: `https://github.com/decentralized-identity/sidetree/projects/1`\n - Render: https://github.com/decentralized-identity/sidetree/projects/1\n\n'})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(p,{...e})}):p(e)}},8453:(e,n,t)=>{t.d(n,{R:()=>r,x:()=>a});var o=t(6540);const i={},s=o.createContext(i);function r(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:r(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f049f840.03bd21f7.js b/assets/js/f049f840.03bd21f7.js deleted file mode 100644 index 610b75de..00000000 --- a/assets/js/f049f840.03bd21f7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[418],{483:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"Admins Guide","href":"/spec-up-t-website/docs/admins-guide","docId":"admins-guide","unlisted":false},{"type":"link","label":"General Guide","href":"/spec-up-t-website/docs/general-guide","docId":"general-guide","unlisted":false},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Content Authors Guide","href":"/spec-up-t-website/docs/content-authors-guide/introduction","docId":"content-authors-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/content-authors-guide"},{"type":"category","label":"Terminology Author Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Terminology Authors Guide","href":"/spec-up-t-website/docs/terminology-authors-guide/introduction","docId":"terminology-authors-guide/introduction","unlisted":false},{"type":"link","label":"Term References","href":"/spec-up-t-website/docs/terminology-authors-guide/term-references","docId":"terminology-authors-guide/term-references","unlisted":false},{"type":"link","label":"External Term References","href":"/spec-up-t-website/docs/terminology-authors-guide/external-term-references","docId":"terminology-authors-guide/external-term-references","unlisted":false}],"href":"/spec-up-t-website/docs/category/terminology-author-guide"},{"type":"category","label":"Curators Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Curators Guide","href":"/spec-up-t-website/docs/curators-guide/introduction","docId":"curators-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/curators-guide"},{"type":"category","label":"Glossary Maintainers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary Maintainers Guide","href":"/spec-up-t-website/docs/glossary-maintainers-guide/introduction","docId":"glossary-maintainers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/glossary-maintainers-guide"},{"type":"category","label":"Readers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Readers Guide","href":"/spec-up-t-website/docs/readers-guide/introduction","docId":"readers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/readers-guide"},{"type":"link","label":"Spec-Up-T demo site","href":"/spec-up-t-website/docs/spec-up-t-demo-site","docId":"spec-up-t-demo-site","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":"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":"Developers Guide","href":"/spec-up-t-website/docs/developers-guide","docId":"developers-guide","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":{"admins-guide":{"id":"admins-guide","title":"Admins Guide","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"content-authors-guide/introduction":{"id":"content-authors-guide/introduction","title":"Content Authors Guide","description":"Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.","sidebar":"tutorialSidebar"},"curators-guide/introduction":{"id":"curators-guide/introduction","title":"Curators Guide","description":"Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context.","sidebar":"tutorialSidebar"},"developers-guide":{"id":"developers-guide","title":"Developers Guide","description":"This is the developers guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"general-guide":{"id":"general-guide","title":"General Guide","description":"These are general instructions.","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"},"glossary-maintainers-guide/introduction":{"id":"glossary-maintainers-guide/introduction","title":"Glossary Maintainers Guide","description":"Uses: Source management tool.","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"},"readers-guide/introduction":{"id":"readers-guide/introduction","title":"Readers Guide","description":"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.","sidebar":"tutorialSidebar"},"spec-up-t-demo-site":{"id":"spec-up-t-demo-site","title":"Spec-Up-T demo site","description":"The Demo","sidebar":"tutorialSidebar"},"terminology-authors-guide/external-term-references":{"id":"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"},"terminology-authors-guide/introduction":{"id":"terminology-authors-guide/introduction","title":"Terminology Authors Guide","description":"Focusses on term definitions covering concepts of the group he/she belongs to.","sidebar":"tutorialSidebar"},"terminology-authors-guide/term-references":{"id":"terminology-authors-guide/term-references","title":"Term References","description":"Definition Lists","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"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/f049f840.4fd0520c.js b/assets/js/f049f840.4fd0520c.js new file mode 100644 index 00000000..603109c5 --- /dev/null +++ b/assets/js/f049f840.4fd0520c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[418],{483:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Introduction","href":"/spec-up-t-website/docs/intro","docId":"intro","unlisted":false},{"type":"link","label":"Admins Guide","href":"/spec-up-t-website/docs/admins-guide","docId":"admins-guide","unlisted":false},{"type":"link","label":"General Guide","href":"/spec-up-t-website/docs/general-guide","docId":"general-guide","unlisted":false},{"type":"category","label":"Content Authors Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Content Authors Guide","href":"/spec-up-t-website/docs/content-authors-guide/introduction","docId":"content-authors-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/content-authors-guide"},{"type":"category","label":"Terminology Author Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Terminology Authors Guide","href":"/spec-up-t-website/docs/terminology-authors-guide/introduction","docId":"terminology-authors-guide/introduction","unlisted":false},{"type":"link","label":"Term References","href":"/spec-up-t-website/docs/terminology-authors-guide/term-references","docId":"terminology-authors-guide/term-references","unlisted":false},{"type":"link","label":"External Term References","href":"/spec-up-t-website/docs/terminology-authors-guide/external-term-references","docId":"terminology-authors-guide/external-term-references","unlisted":false}],"href":"/spec-up-t-website/docs/category/terminology-author-guide"},{"type":"category","label":"Curators Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Curators Guide","href":"/spec-up-t-website/docs/curators-guide/introduction","docId":"curators-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/curators-guide"},{"type":"category","label":"Glossary Maintainers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Glossary Maintainers Guide","href":"/spec-up-t-website/docs/glossary-maintainers-guide/introduction","docId":"glossary-maintainers-guide/introduction","unlisted":false}],"href":"/spec-up-t-website/docs/category/glossary-maintainers-guide"},{"type":"category","label":"Readers Guide","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Readers Guide","href":"/spec-up-t-website/docs/readers-guide/introduction","docId":"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/developers-guide","docId":"developers-guide","unlisted":false},{"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":{"admins-guide":{"id":"admins-guide","title":"Admins Guide","description":"This is the admin guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"content-authors-guide/introduction":{"id":"content-authors-guide/introduction","title":"Content Authors Guide","description":"Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.","sidebar":"tutorialSidebar"},"curators-guide/introduction":{"id":"curators-guide/introduction","title":"Curators Guide","description":"Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context.","sidebar":"tutorialSidebar"},"developers-guide":{"id":"developers-guide","title":"Developers Guide","description":"This is the developers guide for the Spec-Up-T system.","sidebar":"tutorialSidebar"},"general-guide":{"id":"general-guide","title":"General Guide","description":"These are general instructions.","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"},"glossary-maintainers-guide/introduction":{"id":"glossary-maintainers-guide/introduction","title":"Glossary Maintainers Guide","description":"Uses: Source management tool.","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"},"readers-guide/introduction":{"id":"readers-guide/introduction","title":"Readers Guide","description":"Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.","sidebar":"tutorialSidebar"},"spec-up-t-demo-site":{"id":"spec-up-t-demo-site","title":"Spec-Up-T demo","description":"The Demo","sidebar":"tutorialSidebar"},"terminology-authors-guide/external-term-references":{"id":"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"},"terminology-authors-guide/introduction":{"id":"terminology-authors-guide/introduction","title":"Terminology Authors Guide","description":"Focusses on term definitions covering concepts of the group he/she belongs to.","sidebar":"tutorialSidebar"},"terminology-authors-guide/term-references":{"id":"terminology-authors-guide/term-references","title":"Term References","description":"Definition Lists","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"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.d31b5940.js b/assets/js/runtime~main.e03e3725.js similarity index 90% rename from assets/js/runtime~main.d31b5940.js rename to assets/js/runtime~main.e03e3725.js index 042d3c84..f9fdb797 100644 --- a/assets/js/runtime~main.d31b5940.js +++ b/assets/js/runtime~main.e03e3725.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,t,r,c,f={},d={};function o(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return f[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=f,o.c=d,e=[],o.O=(a,t,r,c)=>{if(!t){var f=1/0;for(i=0;i=c)&&Object.keys(o.O).every((e=>o.O[e](t[n])))?t.splice(n--,1):(d=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[t,r,c]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.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 c=Object.create(null);o.r(c);var f={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,o.d(c,f),c},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({13:"9d9f8394",48:"a94703ab",51:"e747ec83",61:"1f391b9e",66:"acc96f77",98:"a7bd4aaa",134:"393be207",157:"e0c4e08d",167:"9428579a",192:"2be7da73",235:"a7456010",249:"ccc49370",301:"7352707a",345:"680248e1",373:"1e2342fa",392:"3dc49084",398:"e2490c2d",401:"17896441",418:"f049f840",422:"738e0f00",431:"ecd4a663",449:"fdea42e3",452:"f70ccc90",472:"814f3328",481:"4741e212",494:"9f502ea7",509:"c4a0550b",538:"8edce930",548:"3e8d065b",561:"08e3fca0",634:"c4f5d8e4",643:"a6aa9e1f",647:"5e95c892",685:"4d95055f",711:"9e4087bc",715:"f49b999f",742:"aba21aa0",858:"36994c47",865:"166ee7c9",871:"8050fd0a",903:"acecf23e",969:"14eb3368",976:"0e384e19"}[e]||e)+"."+{13:"f63b4fe8",48:"bbf09f2c",51:"21f0ebc3",61:"bea182c1",66:"a1b8f2c2",98:"e61c3b7b",134:"6a78c15a",157:"ad62afba",167:"41526df7",192:"6c27dffc",235:"d27e4924",237:"f4fbea9d",249:"589d1dc3",261:"12b02a80",300:"8dc279ed",301:"5897ffe2",345:"a5ff402e",373:"413d2147",392:"8790a5ee",398:"c6c2267c",401:"247000cb",418:"03bd21f7",422:"082cebe7",431:"df229edb",449:"1af32f0c",452:"6dc6ebc4",472:"d1eea19c",481:"3e923282",494:"c3f2e84e",509:"6aa12fab",538:"14c1a3ba",548:"7012bfbd",561:"99217aae",634:"a72359e0",643:"e4f15be8",647:"7afa0510",685:"396cc1d9",711:"d3f8ed7f",715:"8c0d6d53",742:"bddde0da",858:"f2ddbf25",865:"859e5059",871:"6ee49d6c",903:"d383a297",969:"c0626e6f",976:"af553f1c"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},c="my-website:",o.l=(e,a,t,f)=>{if(r[e])r[e].push(a);else{var d,n;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var c=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),c&&c.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),n&&document.head.appendChild(d)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.p="/spec-up-t-website/",o.gca=function(e){return e={17896441:"401","9d9f8394":"13",a94703ab:"48",e747ec83:"51","1f391b9e":"61",acc96f77:"66",a7bd4aaa:"98","393be207":"134",e0c4e08d:"157","9428579a":"167","2be7da73":"192",a7456010:"235",ccc49370:"249","7352707a":"301","680248e1":"345","1e2342fa":"373","3dc49084":"392",e2490c2d:"398",f049f840:"418","738e0f00":"422",ecd4a663:"431",fdea42e3:"449",f70ccc90:"452","814f3328":"472","4741e212":"481","9f502ea7":"494",c4a0550b:"509","8edce930":"538","3e8d065b":"548","08e3fca0":"561",c4f5d8e4:"634",a6aa9e1f:"643","5e95c892":"647","4d95055f":"685","9e4087bc":"711",f49b999f:"715",aba21aa0:"742","36994c47":"858","166ee7c9":"865","8050fd0a":"871",acecf23e:"903","14eb3368":"969","0e384e19":"976"}[e]||e,o.p+o.u(e)},(()=>{var e={354:0,869:0};o.f.j=(a,t)=>{var r=o.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 c=new Promise(((t,c)=>r=e[a]=[t,c]));t.push(r[2]=c);var f=o.p+o.u(a),d=new Error;o.l(f,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var c=t&&("load"===t.type?"missing":t.type),f=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",d.name="ChunkLoadError",d.type=c,d.request=f,r[1](d)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,c,f=t[0],d=t[1],n=t[2],b=0;if(f.some((a=>0!==e[a]))){for(r in d)o.o(d,r)&&(o.m[r]=d[r]);if(n)var i=n(o)}for(a&&a(t);b{"use strict";var e,a,t,r,c,f={},d={};function o(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return f[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=f,o.c=d,e=[],o.O=(a,t,r,c)=>{if(!t){var f=1/0;for(i=0;i=c)&&Object.keys(o.O).every((e=>o.O[e](t[n])))?t.splice(n--,1):(d=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[t,r,c]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.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 c=Object.create(null);o.r(c);var f={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>f[a]=()=>e[a]));return f.default=()=>e,o.d(c,f),c},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({13:"9d9f8394",48:"a94703ab",51:"e747ec83",61:"1f391b9e",66:"acc96f77",98:"a7bd4aaa",134:"393be207",157:"e0c4e08d",167:"9428579a",192:"2be7da73",235:"a7456010",249:"ccc49370",301:"7352707a",345:"680248e1",373:"1e2342fa",392:"3dc49084",398:"e2490c2d",401:"17896441",418:"f049f840",422:"738e0f00",431:"ecd4a663",449:"fdea42e3",452:"f70ccc90",472:"814f3328",481:"4741e212",494:"9f502ea7",509:"c4a0550b",538:"8edce930",548:"3e8d065b",561:"08e3fca0",634:"c4f5d8e4",643:"a6aa9e1f",647:"5e95c892",685:"4d95055f",711:"9e4087bc",715:"f49b999f",742:"aba21aa0",858:"36994c47",865:"166ee7c9",871:"8050fd0a",903:"acecf23e",969:"14eb3368",976:"0e384e19"}[e]||e)+"."+{13:"f63b4fe8",48:"bbf09f2c",51:"21f0ebc3",61:"bea182c1",66:"a1b8f2c2",98:"e61c3b7b",134:"6a78c15a",157:"c309d43b",167:"c8401bd0",192:"128b5fd3",235:"d27e4924",237:"f4fbea9d",249:"589d1dc3",261:"12b02a80",300:"8dc279ed",301:"5897ffe2",345:"a5ff402e",373:"413d2147",392:"3c6f0e3f",398:"c6c2267c",401:"247000cb",418:"4fd0520c",422:"082cebe7",431:"df229edb",449:"1af32f0c",452:"6dc6ebc4",472:"d1eea19c",481:"3e923282",494:"c3f2e84e",509:"f4702d3e",538:"14c1a3ba",548:"7012bfbd",561:"99217aae",634:"a72359e0",643:"e4f15be8",647:"7afa0510",685:"396cc1d9",711:"d3f8ed7f",715:"8c0d6d53",742:"bddde0da",858:"f2ddbf25",865:"859e5059",871:"0a99c9ed",903:"d383a297",969:"c0626e6f",976:"af553f1c"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},c="my-website:",o.l=(e,a,t,f)=>{if(r[e])r[e].push(a);else{var d,n;if(void 0!==t)for(var b=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var c=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),c&&c.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),n&&document.head.appendChild(d)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.p="/spec-up-t-website/",o.gca=function(e){return e={17896441:"401","9d9f8394":"13",a94703ab:"48",e747ec83:"51","1f391b9e":"61",acc96f77:"66",a7bd4aaa:"98","393be207":"134",e0c4e08d:"157","9428579a":"167","2be7da73":"192",a7456010:"235",ccc49370:"249","7352707a":"301","680248e1":"345","1e2342fa":"373","3dc49084":"392",e2490c2d:"398",f049f840:"418","738e0f00":"422",ecd4a663:"431",fdea42e3:"449",f70ccc90:"452","814f3328":"472","4741e212":"481","9f502ea7":"494",c4a0550b:"509","8edce930":"538","3e8d065b":"548","08e3fca0":"561",c4f5d8e4:"634",a6aa9e1f:"643","5e95c892":"647","4d95055f":"685","9e4087bc":"711",f49b999f:"715",aba21aa0:"742","36994c47":"858","166ee7c9":"865","8050fd0a":"871",acecf23e:"903","14eb3368":"969","0e384e19":"976"}[e]||e,o.p+o.u(e)},(()=>{var e={354:0,869:0};o.f.j=(a,t)=>{var r=o.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 c=new Promise(((t,c)=>r=e[a]=[t,c]));t.push(r[2]=c);var f=o.p+o.u(a),d=new Error;o.l(f,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var c=t&&("load"===t.type?"missing":t.type),f=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+c+": "+f+")",d.name="ChunkLoadError",d.type=c,d.request=f,r[1](d)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,c,f=t[0],d=t[1],n=t[2],b=0;if(f.some((a=>0!==e[a]))){for(r in d)o.o(d,r)&&(o.m[r]=d[r]);if(n)var i=n(o)}for(a&&a(t);b Archive | Spec-Up-T - + diff --git a/blog/index.html b/blog/index.html index 324d155d..576642bd 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,7 +5,7 @@ Blog | Spec-Up-T - + diff --git a/blog/welcome/index.html b/blog/welcome/index.html index db45653b..b8ec4bbd 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,7 +5,7 @@ Welcome | Spec-Up-T - + diff --git a/docs/admins-guide/index.html b/docs/admins-guide/index.html index 5d9c2ce6..fa0d329b 100644 --- a/docs/admins-guide/index.html +++ b/docs/admins-guide/index.html @@ -5,11 +5,11 @@ Admins Guide | Spec-Up-T - + -

Admins Guide

+

Admins Guide

This is the admin guide for the Spec-Up-T system.

The repo can be found here

Installation​

diff --git a/docs/category/content-authors-guide/index.html b/docs/category/content-authors-guide/index.html index d87df158..a25f9ac3 100644 --- a/docs/category/content-authors-guide/index.html +++ b/docs/category/content-authors-guide/index.html @@ -5,10 +5,10 @@ Content Authors Guide | Spec-Up-T - + -

Content Authors Guide

Content Authors Guide.

+

Content Authors Guide

Content Authors Guide.

\ No newline at end of file diff --git a/docs/category/curators-guide/index.html b/docs/category/curators-guide/index.html index a5b65a33..bb20b55c 100644 --- a/docs/category/curators-guide/index.html +++ b/docs/category/curators-guide/index.html @@ -5,10 +5,10 @@ Curators Guide | Spec-Up-T - + -

Curators Guide

Curators Guide.

+

Curators Guide

Curators Guide.

\ No newline at end of file diff --git a/docs/category/glossary-maintainers-guide/index.html b/docs/category/glossary-maintainers-guide/index.html index f535d2eb..9b1ccbe4 100644 --- a/docs/category/glossary-maintainers-guide/index.html +++ b/docs/category/glossary-maintainers-guide/index.html @@ -5,10 +5,10 @@ Glossary Maintainers Guide | Spec-Up-T - + -

Glossary Maintainers Guide

Glossary Maintainers Guide.

+

Glossary Maintainers Guide

Glossary Maintainers Guide.

\ No newline at end of file diff --git a/docs/category/readers-guide/index.html b/docs/category/readers-guide/index.html index 707a21ed..613a4398 100644 --- a/docs/category/readers-guide/index.html +++ b/docs/category/readers-guide/index.html @@ -5,10 +5,10 @@ Readers Guide | Spec-Up-T - + -

Readers Guide

Readers Guide.

+

Readers Guide

Readers Guide.

\ No newline at end of file diff --git a/docs/category/terminology-author-guide/index.html b/docs/category/terminology-author-guide/index.html index 62a06aec..67a6577f 100644 --- a/docs/category/terminology-author-guide/index.html +++ b/docs/category/terminology-author-guide/index.html @@ -5,10 +5,10 @@ Terminology Author Guide | Spec-Up-T - + -

Terminology Author Guide

Terminology Author Guide.

+

Terminology Author Guide

Terminology Author Guide.

\ No newline at end of file diff --git a/docs/content-authors-guide/introduction/index.html b/docs/content-authors-guide/introduction/index.html index 62b9db25..9faf6f0b 100644 --- a/docs/content-authors-guide/introduction/index.html +++ b/docs/content-authors-guide/introduction/index.html @@ -5,11 +5,11 @@ Content Authors Guide | Spec-Up-T - + -

Content Authors Guide

+

Content Authors Guide

Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.

He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions.

diff --git a/docs/curators-guide/introduction/index.html b/docs/curators-guide/introduction/index.html index 9b9ed9b3..ac73c9fe 100644 --- a/docs/curators-guide/introduction/index.html +++ b/docs/curators-guide/introduction/index.html @@ -5,11 +5,11 @@ Curators Guide | Spec-Up-T - + -

Curators Guide

+

Curators Guide

Uses an IDE and git and browser extensions, to check logical consistency & meaning of term definition in a certain context.

Uses browser extensions to harvest a personal collection of term definitions, based on those recommended by the specification authors.

diff --git a/docs/developers-guide/index.html b/docs/developers-guide/index.html index 03499b3e..6dd05151 100644 --- a/docs/developers-guide/index.html +++ b/docs/developers-guide/index.html @@ -5,11 +5,11 @@ Developers Guide | Spec-Up-T - + -

Developers Guide

+

Developers Guide

This is the developers guide for the Spec-Up-T system.

The repo can be found here.

How do you get a new version of Spec-Up-T live?​

@@ -42,6 +42,6 @@

Gulpinstalled.

warning

If Gulp suddenly stops working even though it worked before, it could be because you are using NVM and have a different Node.js version active.

Adding server-side functionality​

-

To be written.

+

To be written.

\ No newline at end of file diff --git a/docs/general-guide/index.html b/docs/general-guide/index.html index efad609d..7649584b 100644 --- a/docs/general-guide/index.html +++ b/docs/general-guide/index.html @@ -5,11 +5,11 @@ General Guide | Spec-Up-T - + -

General Guide

+

General Guide

These are general instructions.

Look up xrefs​

Xrefs are [To Do: write explanation]

diff --git a/docs/glossary-maintainers-guide/introduction/index.html b/docs/glossary-maintainers-guide/introduction/index.html index 17b90a92..a44fd578 100644 --- a/docs/glossary-maintainers-guide/introduction/index.html +++ b/docs/glossary-maintainers-guide/introduction/index.html @@ -5,11 +5,11 @@ Glossary Maintainers Guide | Spec-Up-T - + -

Glossary Maintainers Guide

+

Glossary Maintainers Guide

Uses: Source management tool.

Reads and compares concepts in text and terminology in glossaries, (for example generated by Spec-Up) to use within his/hers “own” over-arching ToIP glossary.

He/she builds as much consensus around terms and concepts and promotes using the ToIP glossary as reference material.

diff --git a/docs/glossary/index.html b/docs/glossary/index.html index 3f3338de..1d0e570e 100644 --- a/docs/glossary/index.html +++ b/docs/glossary/index.html @@ -5,11 +5,11 @@ Glossary | Spec-Up-T - + -

Glossary

+

Glossary

This is a glossary with some terms that you need to know in order to understand working with Spec-Up-T.

This glossary was not created in Spec-Up-T, it could have been, but to avoid confusion we did not.

Git and Github​

diff --git a/docs/how-it-came-to-be/index.html b/docs/how-it-came-to-be/index.html index 71e342af..3924d042 100644 --- a/docs/how-it-came-to-be/index.html +++ b/docs/how-it-came-to-be/index.html @@ -5,11 +5,11 @@ How it came to be | Spec-Up-T - + -

How it came to be

+

How it came to be

The ToIP Terms extension of Spec-Up​

This article is meant for technical experts in Spec-Up and git.

What is Spec-Up, what is Spec-Up-T and why do we need a fork? Could we move faster by creating our own? Do objectives diverge? Is it possible to work together in a better and more productive way? @@ -111,6 +111,6 @@

Edit this page

+
\ No newline at end of file diff --git a/docs/intro/index.html b/docs/intro/index.html index 7bb0ac51..2033d59a 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,11 +5,11 @@ Introduction | Spec-Up-T - + -

Introduction

+

Introduction

Intro​

Spec-Up-T is a tool that helps you write specifications. It is a tool for writing in Markdown and creates one index.html file. This index.html file is stand-alone and can be hosted on any webserver. Or double click it and it will open.

The code is available on Github.

diff --git a/docs/q-and-a/index.html b/docs/q-and-a/index.html index 01980ad0..951a5da0 100644 --- a/docs/q-and-a/index.html +++ b/docs/q-and-a/index.html @@ -5,11 +5,11 @@ Q & A | Spec-Up-T - + -

Q & A

+

Q & A

Questions and answers about Spec-Up-T.

When I use Spec-Up-T do I get all the updates of Spec-Up too?​

Yes. The administrator team behind Spec-Up-T will keep Spec-Up of DIF as a strict subset of code and features.

@@ -27,7 +27,7 @@

What is the command for help?​

TODO: npx Spec-Up-T --help gives all commands I can give.

-

Why does Spec-Up-T look so complicated?​

+

Why does Spec-Up-T look so complicated?​

Spec-Up was simple, Spec-Up-T looks complicated, why?

Spec-Up is a subset of Spec-Up-T. The expansion "T" complicates the handling of term definitions, - references and external references (xrefs) of term in other repo's glossaries. ToIP added functionality as well: diff tooling, search bar, and navigation aids.

@@ -49,6 +49,6 @@

NoInstalling Spec-Up-T inside Docusaurus (or Jekyll, etc) is possible, however it is not recommended practice to have nested node_modules directories. Docusaurus (or Jekyll, etc) have their own node_modules directory. You can install Spec-Up-T in a sub directory in which it will get it's own node_modules directory after installation but this is not recommended.

Yes​

You can install Spec-Up-T in it's own separate directory in your file system and generate the index.html file. This file can be moved around freely and live in it's own directory, for example in the /static directory of your Docusaurus site. You can rename index.html to foo.html or whatever you like. You could link to this file from other files in your Docusaurus site.

-

However, the Spec-Up-T file (a one-page website) will have it's own menu and have no connection to your Docusaurus site.

+

However, the Spec-Up-T file (a one-page website) will have it's own menu and have no connection to your Docusaurus site.

\ No newline at end of file diff --git a/docs/readers-guide/introduction/index.html b/docs/readers-guide/introduction/index.html index a951733e..4e8a081c 100644 --- a/docs/readers-guide/introduction/index.html +++ b/docs/readers-guide/introduction/index.html @@ -5,11 +5,11 @@ Readers Guide | Spec-Up-T - + -

Readers Guide

-

Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.

+

Readers Guide

+

Uses github.io website, reads concepts in text and terminology in glossaries, (for example generated by Spec-Up) with its own tailor-made contextual glossary that generates pop-ups here and there in the text offered.

\ No newline at end of file diff --git a/docs/spec-up-t-demo-site/index.html b/docs/spec-up-t-demo-site/index.html index 321989b4..83fd65aa 100644 --- a/docs/spec-up-t-demo-site/index.html +++ b/docs/spec-up-t-demo-site/index.html @@ -3,13 +3,13 @@ -Spec-Up-T demo site | Spec-Up-T +Spec-Up-T demo | Spec-Up-T - + -

Spec-Up-T demo site

+

Spec-Up-T demo

The Demo​

Below is a demo of the Spec-Up-T website in an iFrame. You can also open the Spec-Up-T website in a standalone window by clicking here.

This demo showcases how a Spec-Up-T specification (a single index.html file) can be integrated into other systems.

@@ -28,6 +28,6 @@

En

The markdown​

Below is the markdown of the “Demo of example markup in Spec-Up-T and Markdown” section of demo Spec-Up-T above:

-
## Demo of example markup in Spec-Up-T and Markdown

### Blockquote

> To be, or not to be, that is the question:
Whether 'tis nobler in the mind to suffer
The slings and arrows of outrageous fortune,
Or to take arms against a sea of troubles
And by opposing end them. To die—to sleep,
No more;

### Notices

<pre>
::: note Basic Note
  Check this out.
:::
</pre>

::: note Basic Note
  Check this out.
:::

::: note
  Here's another.
:::

::: note
  And one more!
:::

::: note Basic Note
  One last note!!!
:::

<pre>
::: issue Issue Notice
  I take issue with that, kind sir.
:::
</pre>

::: issue Issue Notice
  I take issue with that, kind sir.
:::

<pre>
::: warning Warning Notice
  Houston, I think we have a problem
:::
</pre>

::: warning Warning Notice
  Houston, I think we have a problem
:::

<pre>
::: todo Really Important
  Get this done!
:::
</pre>

::: todo Really Important
  Get this done!
:::

<pre>
::: example Code Example
  Put your code block here
:::
</pre>

::: example Code Example

\`\`\`json
// Some comment in JSON
{
  "foo": "bar",
  "baz": 2
}
\`\`\`

:::

### Content Insertion

Use the following format to pull in content from other files in your project:

<pre>
This text has been inserted here from another file: &#91;&#91;insert: assets/test.text&#93;&#93;
</pre>

This text has been inserted here from another file: [[insert: assets/test.text]]

You can even insert content within more complex blocks, like the JSON object below which is being pulled in and rendered in a syntax-highlighted example block:
<pre>
::: example Code Example
\`\`\`json
&#91;&#91;insert: assets/test.json&#93;&#93;
\`\`\`
:::
</pre>

::: example Code Example

\`\`\`json
[[insert: assets/test.json]]
\`\`\`

:::

### Tables

<pre>
Stage | Direct Products | ATP Yields
----: | --------------: | ---------:
Glycolysis | 2 ATP ||
^^ | 2 NADH | 3--5 ATP |
Pyruvaye oxidation | 2 NADH | 5 ATP |
Citric acid cycle | 2 ATP ||
^^ | 6 NADH | 15 ATP |
^^ | 2 FADH2 | 3 ATP |
**30--32** ATP |||
[Net ATP yields per hexose]
</pre>

Stage | Direct Products | ATP Yields
----: | --------------: | ---------:
Glycolysis | 2 ATP ||
^^ | 2 NADH | 3--5 ATP |
Pyruvaye oxidation | 2 NADH | 5 ATP |
Citric acid cycle | 2 ATP ||
^^ | 6 NADH | 15 ATP |
^^ | 2 FADH2 | 3 ATP |
**30--32** ATP |||
[Net ATP yields per hexose]

<pre>
|--|--|--|--|--|--|--|--|
|♜|  |♝|♛|♚|♝|♞|♜|
|  |♟|♟|♟|  |♟|♟|♟|
|♟|  |♞|  |  |  |  | |
|  |♗|  |  |♟|  |  | |
|  |  |  |  |♙|  |  | |
|  |  |  |  |  |♘|  | |
|♙|♙|♙|♙|  |♙|♙|♙|
|♖|♘|♗|♕|♔|  |  |♖|
</pre>

|--|--|--|--|--|--|--|--|
|♜|  |♝|♛|♚|♝|♞|♜ |
|  |♟|♟|♟|  |♟|♟|♟ |
|♟|  |♞|  |  |  |  |  |
|  |♗|  |  |♟|  |  |  |
|  |  |  |  |♙|  |  |  |
|  |  |  |  |  |♘|  |  |
|♙|♙|♙|♙|  |♙|♙|♙ |
|♖|♘|♗|♕|♔|  |  |♖ |

### Sequence Diagrams

<pre>
\`\`\`mermaid
sequenceDiagram
  Alice ->> Bob: Hello Bob, how are you?
  Bob-->>John: How about you John?
  Bob--x Alice: I am good thanks!
  Bob-x John: I am good thanks!
  Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

  Bob-->Alice: Checking with John...
  Alice->John: Yes... John, how are you?
\`\`\`
</pre>

\`\`\`mermaid
sequenceDiagram
  Alice ->> Bob: Hello Bob, how are you?
  Bob-->>John: How about you John?
  Bob--x Alice: I am good thanks!
  Bob-x John: I am good thanks!
  Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

  Bob-->Alice: Checking with John...
  Alice->John: Yes... John, how are you?
\`\`\`

### Flows

<pre>
\`\`\`mermaid
graph TD
  A[Start] --> B{Is it?}
  B -->|Yes| C[OK]
  C --> D[Rethink]
  D --> B
  B -->|No| E[End]
\`\`\`
</pre>

\`\`\`mermaid
graph TD
  A[Start] --> B{Is it?}
  B -->|Yes| C[OK]
  C --> D[Rethink]
  D --> B
  B -->|No| E[End]
\`\`\`

### Charts

<pre>
\`\`\`chart
{
  "type": "pie",
  "data": {
    "labels": [
      "Red",
      "Blue",
      "Yellow"
    ],
    "datasets": [
      {
        "data": [
          300,
          50,
          100
        ],
        "backgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ],
        "hoverBackgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ]
      }
    ]
  }
}
\`\`\`
</pre>

\`\`\`chart
{
  "type": "pie",
  "data": {
    "labels": [
      "Red",
      "Blue",
      "Yellow"
    ],
    "datasets": [
      {
        "data": [
          300,
          50,
          100
        ],
        "backgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ],
        "hoverBackgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ]
      }
    ]
  }
}
\`\`\`

### Syntax Highlighting

<pre>
\`\`\`json
{
  "@context": "https://www.w3.org/ns/did/v1",
  "id": "did:example:123456789abcdefghi",
  "authentication": [{
    "id": "did:example:123456789abcdefghi#keys-1",
    "type": "RsaVerificationKey2018",
    "controller": "did:example:123456789abcdefghi",
    "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\r\n"
  }],
  "service": [{
    "id":"did:example:123456789abcdefghi#vcs",
    "type": "VerifiableCredentialService",
    "serviceEndpoint": "https://example.com/vc/"
  }]
}
\`\`\`
</pre>

\`\`\`json
{
  "@context": "https://www.w3.org/ns/did/v1",
  "id": "did:example:123456789abcdefghi",
  "authentication": [{ 
    "id": "did:example:123456789abcdefghi#keys-1",
    "type": "RsaVerificationKey2018",
    "controller": "did:example:123456789abcdefghi",
    "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\r\n"
  }],
  "service": [{
    "id":"did:example:123456789abcdefghi#vcs",
    "type": "VerifiableCredentialService",
    "serviceEndpoint": "https://example.com/vc/"
  }]
}
\`\`\`

### TeX Math Equations

When the `katex` option is enabled, the KaTeX math engine is used for TeX rendering. You can find a list of supported features and examples here: <https://katex.org/docs/supported.html>.

$$\begin{pmatrix}x_2 \\ y_2 \end{pmatrix} =
\begin{pmatrix} A & B \\ C & D \end{pmatrix}\cdot
\begin{pmatrix} x_1 \\ y_1 \end{pmatrix}$$

$$\def\arraystretch{1.5}
   \begin{array}{c:c:c}
   a & b & c \\ \hline
   d & e & f \\
   \hdashline
   g & h & i
\end{array}$$

$$
\underbrace{a+b+c}_{\text{Note: such math, much wow.}}
$$

### Tab Panels

<tab-panels selected-index="0">
  <nav>
    <button type="button">First Tab</button>
    <button type="button">Second Tab</button>
  </nav>

  <section>

\`\`\`json
{
  "foo": "foo",
  "baz": 1
}
\`\`\`

  </section>
  <section>

\`\`\`json
{
  "foo": "bar",
  "baz": 2
}
\`\`\`

  </section>
</tab-panels>

### Fancy Links

Spec-Up automatically upgrades the links of certain sites, like GitHub. GitHub is the only supported site with Fancy Links right now, but we'll be adding more as we go.

### GitHub

- **Issues**
  - Source: `https://github.com/decentralized-identity/presentation-exchange/issues/119`
  - Render: https://github.com/decentralized-identity/presentation-exchange/issues/119
- **Pull Requests**
  - Source: `https://github.com/decentralized-identity/sidetree/pull/863`
  - Render: https://github.com/decentralized-identity/sidetree/pull/863
- **Releases**
  - Source: `https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1`
  - Render: https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1
- **Projects**
  - Source: `https://github.com/decentralized-identity/sidetree/projects/1`
  - Render: https://github.com/decentralized-identity/sidetree/projects/1

+
## Demo of example markup in Spec-Up-T and Markdown

### Blockquote

> To be, or not to be, that is the question:
Whether 'tis nobler in the mind to suffer
The slings and arrows of outrageous fortune,
Or to take arms against a sea of troubles
And by opposing end them. To die—to sleep,
No more;

### Notices

<pre>
::: note Basic Note
  Check this out.
:::
</pre>

::: note Basic Note
  Check this out.
:::

::: note
  Here's another.
:::

::: note
  And one more!
:::

::: note Basic Note
  One last note!!!
:::

<pre>
::: issue Issue Notice
  I take issue with that, kind sir.
:::
</pre>

::: issue Issue Notice
  I take issue with that, kind sir.
:::

<pre>
::: warning Warning Notice
  Houston, I think we have a problem
:::
</pre>

::: warning Warning Notice
  Houston, I think we have a problem
:::

<pre>
::: todo Really Important
  Get this done!
:::
</pre>

::: todo Really Important
  Get this done!
:::

<pre>
::: example Code Example
  Put your code block here
:::
</pre>

::: example Code Example

\`\`\`json
// Some comment in JSON
{
  "foo": "bar",
  "baz": 2
}
\`\`\`

:::

### Content Insertion

Use the following format to pull in content from other files in your project:

<pre>
This text has been inserted here from another file: &#91;&#91;insert: assets/test.text&#93;&#93;
</pre>

This text has been inserted here from another file: [[insert: assets/test.text]]

You can even insert content within more complex blocks, like the JSON object below which is being pulled in and rendered in a syntax-highlighted example block:
<pre>
::: example Code Example
\`\`\`json
&#91;&#91;insert: assets/test.json&#93;&#93;
\`\`\`
:::
</pre>

::: example Code Example

\`\`\`json
[[insert: assets/test.json]]
\`\`\`

:::

### Tables

<pre>
Stage | Direct Products | ATP Yields
----: | --------------: | ---------:
Glycolysis | 2 ATP ||
^^ | 2 NADH | 3--5 ATP |
Pyruvaye oxidation | 2 NADH | 5 ATP |
Citric acid cycle | 2 ATP ||
^^ | 6 NADH | 15 ATP |
^^ | 2 FADH2 | 3 ATP |
**30--32** ATP |||
[Net ATP yields per hexose]
</pre>

Stage | Direct Products | ATP Yields
----: | --------------: | ---------:
Glycolysis | 2 ATP ||
^^ | 2 NADH | 3--5 ATP |
Pyruvaye oxidation | 2 NADH | 5 ATP |
Citric acid cycle | 2 ATP ||
^^ | 6 NADH | 15 ATP |
^^ | 2 FADH2 | 3 ATP |
**30--32** ATP |||
[Net ATP yields per hexose]

<pre>
|--|--|--|--|--|--|--|--|
|♜|  |♝|♛|♚|♝|♞|♜|
|  |♟|♟|♟|  |♟|♟|♟|
|♟|  |♞|  |  |  |  | |
|  |♗|  |  |♟|  |  | |
|  |  |  |  |♙|  |  | |
|  |  |  |  |  |♘|  | |
|♙|♙|♙|♙|  |♙|♙|♙|
|♖|♘|♗|♕|♔|  |  |♖|
</pre>

|--|--|--|--|--|--|--|--|
|♜|  |♝|♛|♚|♝|♞|♜ |
|  |♟|♟|♟|  |♟|♟|♟ |
|♟|  |♞|  |  |  |  |  |
|  |♗|  |  |♟|  |  |  |
|  |  |  |  |♙|  |  |  |
|  |  |  |  |  |♘|  |  |
|♙|♙|♙|♙|  |♙|♙|♙ |
|♖|♘|♗|♕|♔|  |  |♖ |

### Sequence Diagrams

<pre>
\`\`\`mermaid
sequenceDiagram
  Alice ->> Bob: Hello Bob, how are you?
  Bob-->>John: How about you John?
  Bob--x Alice: I am good thanks!
  Bob-x John: I am good thanks!
  Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

  Bob-->Alice: Checking with John...
  Alice->John: Yes... John, how are you?
\`\`\`
</pre>

\`\`\`mermaid
sequenceDiagram
  Alice ->> Bob: Hello Bob, how are you?
  Bob-->>John: How about you John?
  Bob--x Alice: I am good thanks!
  Bob-x John: I am good thanks!
  Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

  Bob-->Alice: Checking with John...
  Alice->John: Yes... John, how are you?
\`\`\`

### Flows

<pre>
\`\`\`mermaid
graph TD
  A[Start] --> B{Is it?}
  B -->|Yes| C[OK]
  C --> D[Rethink]
  D --> B
  B -->|No| E[End]
\`\`\`
</pre>

\`\`\`mermaid
graph TD
  A[Start] --> B{Is it?}
  B -->|Yes| C[OK]
  C --> D[Rethink]
  D --> B
  B -->|No| E[End]
\`\`\`

### Charts

<pre>
\`\`\`chart
{
  "type": "pie",
  "data": {
    "labels": [
      "Red",
      "Blue",
      "Yellow"
    ],
    "datasets": [
      {
        "data": [
          300,
          50,
          100
        ],
        "backgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ],
        "hoverBackgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ]
      }
    ]
  }
}
\`\`\`
</pre>

\`\`\`chart
{
  "type": "pie",
  "data": {
    "labels": [
      "Red",
      "Blue",
      "Yellow"
    ],
    "datasets": [
      {
        "data": [
          300,
          50,
          100
        ],
        "backgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ],
        "hoverBackgroundColor": [
          "#FF6384",
          "#36A2EB",
          "#FFCE56"
        ]
      }
    ]
  }
}
\`\`\`

### Syntax Highlighting

<pre>
\`\`\`json
{
  "@context": "https://www.w3.org/ns/did/v1",
  "id": "did:example:123456789abcdefghi",
  "authentication": [{
    "id": "did:example:123456789abcdefghi#keys-1",
    "type": "RsaVerificationKey2018",
    "controller": "did:example:123456789abcdefghi",
    "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\r\n"
  }],
  "service": [{
    "id":"did:example:123456789abcdefghi#vcs",
    "type": "VerifiableCredentialService",
    "serviceEndpoint": "https://example.com/vc/"
  }]
}
\`\`\`
</pre>

\`\`\`json
{
  "@context": "https://www.w3.org/ns/did/v1",
  "id": "did:example:123456789abcdefghi",
  "authentication": [{ 
    "id": "did:example:123456789abcdefghi#keys-1",
    "type": "RsaVerificationKey2018",
    "controller": "did:example:123456789abcdefghi",
    "publicKeyPem": "-----BEGIN PUBLIC KEY...END PUBLIC KEY-----\r\n"
  }],
  "service": [{
    "id":"did:example:123456789abcdefghi#vcs",
    "type": "VerifiableCredentialService",
    "serviceEndpoint": "https://example.com/vc/"
  }]
}
\`\`\`

### TeX Math Equations

When the `katex` option is enabled, the KaTeX math engine is used for TeX rendering. You can find a list of supported features and examples here: <https://katex.org/docs/supported.html>.

$$\begin{pmatrix}x_2 \\ y_2 \end{pmatrix} =
\begin{pmatrix} A & B \\ C & D \end{pmatrix}\cdot
\begin{pmatrix} x_1 \\ y_1 \end{pmatrix}$$

$$\def\arraystretch{1.5}
   \begin{array}{c:c:c}
   a & b & c \\ \hline
   d & e & f \\
   \hdashline
   g & h & i
\end{array}$$

$$
\underbrace{a+b+c}_{\text{Note: such math, much wow.}}
$$

### Tab Panels

<tab-panels selected-index="0">
  <nav>
    <button type="button">First Tab</button>
    <button type="button">Second Tab</button>
  </nav>

  <section>

\`\`\`json
{
  "foo": "foo",
  "baz": 1
}
\`\`\`

  </section>
  <section>

\`\`\`json
{
  "foo": "bar",
  "baz": 2
}
\`\`\`

  </section>
</tab-panels>

### Fancy Links

Spec-Up automatically upgrades the links of certain sites, like GitHub. GitHub is the only supported site with Fancy Links right now, but we'll be adding more as we go.

### GitHub

- **Issues**
  - Source: `https://github.com/decentralized-identity/presentation-exchange/issues/119`
  - Render: https://github.com/decentralized-identity/presentation-exchange/issues/119
- **Pull Requests**
  - Source: `https://github.com/decentralized-identity/sidetree/pull/863`
  - Render: https://github.com/decentralized-identity/sidetree/pull/863
- **Releases**
  - Source: `https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1`
  - Render: https://github.com/decentralized-identity/sidetree/releases/tag/v0.9.1
- **Projects**
  - Source: `https://github.com/decentralized-identity/sidetree/projects/1`
  - Render: https://github.com/decentralized-identity/sidetree/projects/1

\ No newline at end of file diff --git a/docs/terminology-authors-guide/external-term-references/index.html b/docs/terminology-authors-guide/external-term-references/index.html index 4018d5ec..feb8dc07 100644 --- a/docs/terminology-authors-guide/external-term-references/index.html +++ b/docs/terminology-authors-guide/external-term-references/index.html @@ -5,11 +5,11 @@ External Term References | Spec-Up-T - + -

External Term References

+

External Term References

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.

::: example

{
  "specs": [
    {
      ...
      "external_specs": [
        {"test-1": "https://kordwarshuis.github.io/spec-up-xref-test-1/"}
      ]
    }
  ]
}
diff --git a/docs/terminology-authors-guide/introduction/index.html b/docs/terminology-authors-guide/introduction/index.html index 954a6511..b6d3a125 100644 --- a/docs/terminology-authors-guide/introduction/index.html +++ b/docs/terminology-authors-guide/introduction/index.html @@ -5,11 +5,11 @@ Terminology Authors Guide | Spec-Up-T - + -

Terminology Authors Guide

+

Terminology Authors Guide

Focusses on term definitions covering concepts of the group he/she belongs to.

Uses: an IDE, git and a browser extension, to edit Spec-Up markdown files for his/her specific context (mental model) in a version managed environment, authenticated, to write the concept and specification and offer this as a PR.

He/she uses browser extensions to check technical consistency of the links in the text and harvests a personal collection of term definitions. Specification author terms that cover those concepts.

diff --git a/docs/terminology-authors-guide/term-references/index.html b/docs/terminology-authors-guide/term-references/index.html index 427ad825..299634be 100644 --- a/docs/terminology-authors-guide/term-references/index.html +++ b/docs/terminology-authors-guide/term-references/index.html @@ -5,11 +5,11 @@ Term References | Spec-Up-T - + -

Term References

+

Term References

Definition Lists​

Many specs may want to include a section for terminology references, and Definition Lists are a great way to do that. Here's how to leverage Spec-Up's automatic term reference features via Definition List markup:

[[def: Term 1, Term One]]:
diff --git a/docs/this-site-maintainers/index.html b/docs/this-site-maintainers/index.html
index 7287522e..cd905b26 100644
--- a/docs/this-site-maintainers/index.html
+++ b/docs/this-site-maintainers/index.html
@@ -5,15 +5,15 @@
 
 Maintaining this site | Spec-Up-T
 
-
+
 
 
 
-
Maintaining this site

+
Maintaining this site

 
Here you will find information about things specific to this site.

 
Updating the Demo Site​

 
The demo page contains an example of a Spec-Up-T installation in an iFrame. This index.html file is in /static/spec-up-t-demo/docs/.

 
This index.html file is a standard Spec-Up-T installation, as described in the admin section.

-
This index.html file is located in the GitHub repository of this site (the site you are now reading). The Spec-Up-T installation that generated the index file is not stored in any repository since it is a standard installation. You can install and generate it anywhere on your computer, then copy the index file to /static/spec-up-t-demo/docs/.

+
This index.html file is located in the GitHub repository of this site (the site you are now reading). The Spec-Up-T installation that generated the index file is not stored in any repository since it is a standard installation. You can install and generate it anywhere on your computer, then copy the index file to /static/spec-up-t-demo/docs/.

 
 
\ No newline at end of file
diff --git a/docs/troubleshooting/index.html b/docs/troubleshooting/index.html
index 90ad764b..b0c65152 100644
--- a/docs/troubleshooting/index.html
+++ b/docs/troubleshooting/index.html
@@ -5,11 +5,11 @@
 
 Troubleshooting | Spec-Up-T
 
-
+
 
 
 
-
Troubleshooting

+
Troubleshooting

 
Some tips in case of problems:

 
WSL2 users​

 
WSL2 users are recommended to use the bash option rather than PowerShell in the terminal of Visual Studio Code.

diff --git a/index.html b/index.html
index bf7409e5..285110f1 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,7 @@
 
 Spec-Up-T | Spec-Up-T
 
-
+
 
 
 
diff --git a/markdown-page/index.html b/markdown-page/index.html
index 19810fb4..44e6d34b 100644
--- a/markdown-page/index.html
+++ b/markdown-page/index.html
@@ -5,7 +5,7 @@
 
 Markdown page example | Spec-Up-T
 
-
+