spec-up-t 1.0.91 → 1.1.0

package/src/install-from-boilerplate/boilerplate/spec/example-markup-in-markdown.md

@@ -0,0 +1,384 @@
+## 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>
+```js
+{
+  "type": "pie",
+  "data": {
+    "labels": [
+      "Red",
+      "Blue",
+      "Yellow"
+    ],
+    "datasets": [
+      {
+        "data": [
+          300,
+          50,
+          100
+        ],
+        "backgroundColor": [
+          "#FF6384",
+          "#36A2EB",
+          "#FFCE56"
+        ],
+        "hoverBackgroundColor": [
+          "#FF6384",
+          "#36A2EB",
+          "#FFCE56"
+        ]
+      }
+    ]
+  }
+}
+```
+</pre>
+
+```js
+{
+  "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

package/src/install-from-boilerplate/boilerplate/spec/spec-body.md

@@ -0,0 +1,3 @@
+## Outro
+
+Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

package/src/install-from-boilerplate/boilerplate/spec/spec-head.md

@@ -0,0 +1,7 @@
+# Spec-Up-T Demo
+
+## Intro
+
+This is a default Spec-Up-T installation. Find information on the [Spec-Up-T documentation website](https://trustoverip.github.io/spec-up-t-website/).
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

package/src/install-from-boilerplate/boilerplate/spec/terms-and-definitions-intro.md

@@ -0,0 +1,5 @@
+# Terms and Definitions Intro
+
+## Demo terms, definitions and external definitions
+
+A demo of terms and definitions, and references to external definitions.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/term-1.md

@@ -0,0 +1,13 @@
+[[def: term 1, term one, Term One]]
+
+~ Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum faucibus volutpat justo, sed ornare velit.
+
+~ Refs examples: [[ref: Term 2]], [[ref: Term Two]], [[ref: Term 3]].
+
+~ Xref example: [[xref: test-1, Aal]]
+
+~ This Xref example does not work: [[xref: does-not-exist, Foo]]
+
+~ Donec aliquam et ligula id congue. Sed eu urna et tellus placerat viverra. Quisque ut posuere magna, nec accumsan augue. Nullam mauris tortor, semper finibus elementum maximus, imperdiet in felis. Suspendisse quis imperdiet nibh, eget ultrices justo. Pellentesque vitae malesuada justo. Vestibulum quis scelerisque lectus, non rutrum odio. Aenean leo orci, semper non massa sed, facilisis ornare ipsum. Morbi at sem orci. Integer eros mi, faucibus sed lorem id, pharetra imperdiet nisl. Integer viverra enim vel luctus lobortis. Ut turpis tellus, consequat nec lectus et, dictum elementum nunc. Integer rhoncus venenatis molestie. Donec egestas condimentum ligula in porttitor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.
+
+~ Extra text for testing purposes.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/term-2.md

@@ -0,0 +1,3 @@
+[[def: term 2, term two, Term Two]]
+
+~ Pellentesque suscipit ipsum varius, mattis diam in, elementum nunc [[ref: Term 1]], [[ref: Term Three]], [[ref: Term 3]], [[ref: Term 4]]. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec placerat, elit sed tempor viverra, magna ligula porttitor tortor, eget suscipit erat enim vel nisl. Integer vel urna in quam viverra dignissim at in orci. Aliquam erat volutpat. Nam vitae neque nibh. In sollicitudin felis vitae ex finibus, in eleifend lectus efficitur. Vestibulum enim ex, condimentum nec accumsan ut, vestibulum at lacus. Maecenas non vulputate ante. Sed porttitor et eros sit amet venenatis.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/term-3.md

@@ -0,0 +1,3 @@
+[[def: term 3, term three, Term Three]]
+
+~ Nam euismod augue sed tempus imperdiet. Pellentesque ac porta ipsum, sed sodales leo. Suspendisse molestie est sit amet est porta, sit amet molestie dolor pharetra. Duis porta mollis sem vel aliquam. Maecenas laoreet turpis nunc, vitae mattis urna auctor ac. Donec mattis quis urna nec porta. Sed sit amet viverra ligula. Vivamus vitae sem sodales, malesuada dui sit amet, viverra lectus. Integer ullamcorper molestie ante, in blandit nunc tempus auctor.

package/src/install-from-boilerplate/boilerplate/spec/terms-definitions/term-4.md

@@ -0,0 +1,3 @@
+[[def: term 4, term four, Term Four]]
+
+~ Sed lorem nunc, ultricies nec nibh eu, bibendum sollicitudin arcu. Nullam porttitor condimentum elit ac commodo. Aenean ac augue quis arcu congue aliquam vitae in massa. Aliquam erat volutpat. Curabitur lobortis, sapien vitae mattis dignissim, risus augue iaculis risus, sed tempus sapien ex nec massa. Integer quis maximus nunc. Nunc ultrices sapien erat, at congue augue mattis sit amet. Aliquam condimentum luctus nunc, ut euismod augue commodo in.

package/src/install-from-boilerplate/boilerplate/specs.json

@@ -0,0 +1,41 @@
+{
+    "specs": [
+        {
+            "title": "Spec-Up-T Starterpack",
+            "description": "Create technical specifications in markdown. Based on the original Spec-Up, extended with Terminology tooling",
+            "author": "Trust over IP Foundation",
+            "spec_directory": "./spec",
+            "spec_terms_directory": "terms-definitions",
+            "output_path": "./docs",
+            "markdown_paths": [
+                "spec-head.md",
+                "terms-and-definitions-intro.md",
+                "example-markup-in-markdown.md",
+                "spec-body.md"
+            ],
+            "logo": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/logo.svg",
+            "logo_link": "https://github.com/trustoverip/spec-up-t",
+            "favicon": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/favicon.ico",
+            "source": {
+                "host": "github",
+                "account": "trustoverip",
+                "repo": "spec-up-t-starter-pack"
+            },
+            "external_specs": [
+                {
+                    "external_spec": "test-1",
+                    "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-1/",
+                    "url": "https://github.com/blockchainbird/spec-up-xref-test-1",
+                    "terms_dir": "spec/term-definitions"
+                },
+                {
+                    "external_spec": "test-2",
+                    "gh_page": "https://blockchainbird.github.io/spec-up-xref-test-2/",
+                    "url": "https://github.com/blockchainbird/spec-up-xref-test-2",
+                    "terms_dir": "spec/term-definitions"
+                }
+            ],
+            "katex": false
+        }
+    ]
+}