Merge pull request #119 from arc42/nutshell

Nutshell
arc42 · Jun 8, 2024 · d323a8f · d323a8f
2 parents 3a99772 + 479ebf1
commit d323a8f
Show file tree

Hide file tree

Showing 24 changed files with 49 additions and 32 deletions.
diff --git a/_examples/01-overview-example-3.md b/_examples/01-overview-example-3.md
@@ -6,7 +6,8 @@ category: overview
 permalink: /examples/overview-example-3/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 After a short introductory text explaining the system under design a table of key project goals is given and an overview of the functionality is shown as use case diagram with accompaning table
 </div>
 

diff --git a/_examples/01-overview-example-htmlsc-1.md b/_examples/01-overview-example-htmlsc-1.md
@@ -6,8 +6,9 @@ category: overview
 permalink: /examples/overview-example-htmlsc-1/
 ---
 
-<div class="arc42-example" markdown="1">
-The _HTML Sanity Checker_ is an extremely simple and small system.
+<div class="arc42-example">
+<br>
+The <i>HTML Sanity Checker</i> is an extremely simple and small system.
 The overview is given as informal diagram with a brief textual explanation.
 </div>
 

diff --git a/_examples/01-quality-reqs-example-1.md b/_examples/01-quality-reqs-example-1.md
@@ -6,7 +6,8 @@ category: quality-goals
 permalink: /examples/quality-requirements-1/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This example has been created with Enterprise Architect(TM) as a data flow diagram.
 </div>
 

diff --git a/_examples/01-quality-reqs-example-3.md b/_examples/01-quality-reqs-example-3.md
@@ -6,8 +6,9 @@ category: quality-goals
 permalink: /examples/quality-requirements-3/
 ---
 
-<div class="arc42-example" markdown="1">
-We have used a table with categories and detailed decriptions for the top-3 quality goals. More quality requirements can be found in section 10.
+<div class="arc42-example">
+<br>
+We have used a table with categories and detailed descriptions for the top-3 quality goals. More quality requirements can be found in section 10.
 </div>
 
 

diff --git a/_examples/02-constraint-example-1.md b/_examples/02-constraint-example-1.md
@@ -6,7 +6,8 @@ category: constraints
 permalink: /examples/constraints-1/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 Key constraints can often be explained as simple enumeration in plain text.
 </div>
 

diff --git a/_examples/03-context-example-business-1.md b/_examples/03-context-example-business-1.md
@@ -6,7 +6,9 @@ category: business-context
 permalink: /examples/business-context-1/
 ---
 
-<div class="arc42-example" markdown="1">
+
+<div class="arc42-example">
+<br>
 This is a very simple example, created with Enterprise Architect(TM).
 </div>
 
@@ -26,4 +28,4 @@ This is a very simple example, created with Enterprise Architect(TM).
 |local image files |HtmlSC checks if linked images exist as (local) files.     |
 |------|---------|
 |external web resources |HtmlSC can be configured to optionally check for the existence of external web resources. 
-**Risk**: Due to the nature of web systems and the involved remote network operations, this check might need significant time and might yield invalid results due to network and latency issues.  |
+**Risk**: Due to the nature of web systems and the involved remote network operations, this check might need significant time and might yield invalid results due to network and latency issues.  |
diff --git a/_examples/03-context-example-business-2.md b/_examples/03-context-example-business-2.md
@@ -6,7 +6,8 @@ category: business-context
 permalink: /examples/context-business-2/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 A simple diagram with a brief explanation in a table.
 </div>
 

diff --git a/_examples/03-context-example-business-3.md b/_examples/03-context-example-business-3.md
@@ -6,7 +6,8 @@ category: business-context
 permalink: /examples/business-context-3/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This example has been created with Enterprise Architect(TM) as a data flow diagram.
 </div>
 

diff --git a/_examples/03-context-example-technical-1.md b/_examples/03-context-example-technical-1.md
@@ -6,7 +6,8 @@ category: technical-context
 permalink: /examples/technical-context-1/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This is a very simple example, created with Enterprise Architect(TM).
 </div>
 

diff --git a/_examples/03-context-example-technical-4.md b/_examples/03-context-example-technical-4.md
@@ -6,7 +6,8 @@ category: technical-context
 permalink: /examples/technical-context-4/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This example has been created with Enterprise Architect(TM) as a deployment model. 
 </div>
 

diff --git a/_examples/04-solutionStrategy-example-htmlsc-1.md b/_examples/04-solutionStrategy-example-htmlsc-1.md
@@ -7,10 +7,11 @@ permalink: /examples/solution-strategy-htmlsc-1/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 You need a brief summary and explanation of the fundamental solution ideas and strategies. 
 These key ideas should be familiar to everyone involved in development and architecture.
-
+<br>
 Briefly explain how you achieve the most important quality requirements.
 </div>
 

diff --git a/_examples/04-solutionStrategy-example-mama-2.md b/_examples/04-solutionStrategy-example-mama-2.md
@@ -6,10 +6,11 @@ category: solutionstrategy
 permalink: /examples/solution-strategy-mama-2/
 ---
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 You need a brief summary and explanation of the fundamental solution ideas and strategies. 
 These key ideas should be familiar to everyone involved in development and architecture.
-
+<br>
 Briefly explain how you achieve the most important quality requirements.
 </div>
 

diff --git a/_examples/05-buildingblock-example-hsc.md b/_examples/05-buildingblock-example-hsc.md
@@ -7,7 +7,8 @@ permalink: /examples/buildingblock-hsc/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This example contains several levels of the building block view - ranging from the overview level-1 down to very specific and low-level-3.
 </div>
 

diff --git a/_examples/05-buildingblock-example-tpu-lev-1.md b/_examples/05-buildingblock-example-tpu-lev-1.md
@@ -7,7 +7,8 @@ permalink: /examples/buildingblock-tpu-1/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This Level 1 diagram has been created with Enterprise Architect(TM) as a component diagram. It is augmented by a list of black box descriptions for each building block. 
 </div>
 

diff --git a/_examples/05-buildingblock-example-tpu-lev-2.md b/_examples/05-buildingblock-example-tpu-lev-2.md
@@ -7,7 +7,8 @@ permalink: /examples/buildingblock-tpu-2/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 This diagram (created with Enterprise Architect(TM) as a component model) shows the refinement of the measuring box including the level 2 black box descriptions. 
 </div>
 

diff --git a/_examples/06-runtime-example-htmlsc-1.md b/_examples/06-runtime-example-htmlsc-1.md
@@ -7,7 +7,8 @@ permalink: /examples/runtime-1/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 A simple diagram with a brief textual explanation.
 </div>
 

diff --git a/_examples/06-runtime-example-mama-2.md b/_examples/06-runtime-example-mama-2.md
@@ -6,11 +6,6 @@ category: runtime
 permalink: /examples/runtime-mama-2/
 ---
 
-
-<div class="arc42-example" markdown="1">
-
-</div>
-
 ## 6. Runtime View 
 
 ### 6.1 Import File

diff --git a/_examples/06-runtime-example-tpu-1.md b/_examples/06-runtime-example-tpu-1.md
@@ -7,7 +7,8 @@ permalink: /examples/runtime-tpu-1/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 A simple diagram with a brief textual explanation.
 </div>
 

diff --git a/_examples/07-deployment-example-tpu-1.md b/_examples/07-deployment-example-tpu-1.md
@@ -7,7 +7,8 @@ permalink: /examples/deployment-1/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 The example shows an Enterprise Architect (TM) deployment diagram to show the processors used to implement the complete functionality of the Traffic Pursuit Unit. Note the design decisions (i.e. the technology) for the channels connecting the processors.
 </div>
 

diff --git a/_examples/07-deployment-sample-tpu-2.md b/_examples/07-deployment-sample-tpu-2.md
@@ -7,7 +7,8 @@ permalink: /examples/deployment-2/
 ---
 
 
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 The example shows an Enterprise Architect (TM) deployment diagram to show the refinement of one processors.
 </div>
 

diff --git a/_examples/12-glossary-example-htmlsc-1.md b/_examples/12-glossary-example-htmlsc-1.md
@@ -5,7 +5,8 @@ tags: glossary example
 category: glossary
 permalink: /examples/glossary-1/
 ---
-<div class="arc42-example" markdown="1">
+<div class="arc42-example">
+<br>
 Here you find an example of a glossary. 
 </div>
 

diff --git a/_includes/example-header.html b/_includes/example-header.html
@@ -2,7 +2,7 @@
 
         <li> 
             {% if include.link %}
-            <a class="post-link" href="{{ page.url | prepend: site.baseurl }}">{{ page.title }}</a>
+            <a class="post-link" href="{{ page.url | prepend: site.baseurl }}">:{{ page.title }}</a>
             {% else %}
             {{ page.title }}
             {% endif %}

diff --git a/_layouts/default.html b/_layouts/default.html
@@ -4,6 +4,7 @@
     {% capture title %}{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }}{% endcapture %}
     {% seo %}
 
+    <script src="https://cdn.jsdelivr.net/gh/ncase/nutshell/nutshell.js"></script>
     {% include page-url-resolver.html page=page %}
     {% if page.excerpt %}
     {% assign description = page.excerpt | strip_html | strip_newlines | truncate: 160 %}

diff --git a/_pages/section-3.md b/_pages/section-3.md
@@ -27,7 +27,7 @@ your system's most critical aspects. Make sure that you completely understand th
 See below, separated into business- and technical context.
 
 </div>
-
+  
 ### 3.1 Business context
 
 <div class="arc42-help" markdown="1">