Docs: utilized Extensible Markdown include feature

SAKryukov · Dec 21, 2024 · c0fff0e · c0fff0e
1 parent fd622ed
commit c0fff0e
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 17 deletions.
diff --git a/docs/Example.Door.html b/docs/Example.Door.html
@@ -13,6 +13,9 @@
         p.toc br { content: ""; display: block; margin-top: 0.2em; }
         img { width: 70%; display: block; margin-left: auto; margin-right: auto; }
         p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        table, td { border: solid thin black; border-collapse: collapse; font-size: 120%; }
+        table { margin-left: 2em; }
+        td { width: 1.4em; text-align: center; vertical-align: middle; }
     </style>
 </head>
 <body>

diff --git a/docs/Example.Door.md b/docs/Example.Door.md
@@ -10,6 +10,5 @@ The state machine can be represented as
 Locked &#x21D4; Closed &#x21D4; Opened &#x21D4; Opened Inside &#x21D4; Closed Inside &#x21D4; Locked Inside
 ~~~
 
-This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
-for Visual Studio Code.{.extensible-markdown}
+@include(extensible-markdown.md)
 
diff --git a/docs/Example.Grid.html b/docs/Example.Grid.html
@@ -13,6 +13,9 @@
         p.toc br { content: ""; display: block; margin-top: 0.2em; }
         img { width: 70%; display: block; margin-left: auto; margin-right: auto; }
         p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        table, td { border: solid thin black; border-collapse: collapse; font-size: 120%; }
+        table { margin-left: 2em; }
+        td { width: 1.4em; text-align: center; vertical-align: middle; }
     </style>
 </head>
 <body>

diff --git a/docs/Example.Grid.md b/docs/Example.Grid.md
@@ -17,6 +17,4 @@ The example demonstrates the calculation of the longest path between two states
 Maximum number of paths between a pair of states is 5493.
 Total number of paths: 1603536, longest path length: 23.
 
-This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
-for Visual Studio Code.{.extensible-markdown}
-
+@include(extensible-markdown.md)
diff --git a/docs/Example.Non-Emumeration.html b/docs/Example.Non-Emumeration.html
@@ -13,6 +13,9 @@
         p.toc br { content: ""; display: block; margin-top: 0.2em; }
         img { width: 70%; display: block; margin-left: auto; margin-right: auto; }
         p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        table, td { border: solid thin black; border-collapse: collapse; font-size: 120%; }
+        table { margin-left: 2em; }
+        td { width: 1.4em; text-align: center; vertical-align: middle; }
     </style>
 </head>
 <body>
@@ -22,8 +25,7 @@
 MinValue &#x21D4; MaxValue
 NaN &#x21D2; to any other state, but all the transitions to NaN are invalid
 </pre><p class="extensible-markdown">This documentation is generated from the extended Markdown documentation using <a href="https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown">Extensible Markdown</a>
-for Visual Studio Code.</p><div  data-line="25" class="code-line" dir="auto" ></div>
-<script src="https://SAKryukov.github.io/publications/code/source-code-decorator.js"></script>
+for Visual Studio Code.</p><script src="https://SAKryukov.github.io/publications/code/source-code-decorator.js"></script>
 
 
 </body>

diff --git a/docs/Example.Non-Emumeration.md b/docs/Example.Non-Emumeration.md
@@ -20,7 +20,6 @@ MinValue &#x21D4; MaxValue
 NaN &#x21D2; to any other state, but all the transitions to NaN are invalid
 ~~~
 
-This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
-for Visual Studio Code.{.extensible-markdown}
+@include(extensible-markdown.md)
 
 <script src="https://SAKryukov.github.io/publications/code/source-code-decorator.js"></script>
diff --git a/docs/Example.Zoo.html b/docs/Example.Zoo.html
@@ -13,11 +13,14 @@
         p.toc br { content: ""; display: block; margin-top: 0.2em; }
         img { width: 70%; display: block; margin-left: auto; margin-right: auto; }
         p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        table, td { border: solid thin black; border-collapse: collapse; font-size: 120%; }
+        table { margin-left: 2em; }
+        td { width: 1.4em; text-align: center; vertical-align: middle; }
     </style>
 </head>
 <body>
 
-<p class="title">Zoo</p><p><a href="https://github.com/SAKryukov/generic-state-machine/tree/main/code/Tests/TestZoo">Source code</a></p><p>The Zoo example represents the state machine representing the visitor location at the zoo. This is the transition graph:</p><p><img src="zoo.svg" alt="Zoo" data-src="zoo.svg" /></p><p>Note that all the transitions are <em>undirected</em> except the transition between Flamingo and Exit, because entering the zoo area using the exit is not allowed.</p><p>The example demonstrates valid transitions and the attempt to perform some invalid transitions. In particular, each attempt to enter the Chimpanzee area shows the message “Chimpanzee area is temporarily closed”.</p><p>The example also demonstrates <a href="index.html#heading-labyrinth">StateMachine.Labyrinth</a>, <a href="index.html#heading-longestpaths">StateMachine.LongestPaths</a> (<a href="https://en.wikipedia.org/wiki/NP-hardness">NP-hard</a>), <a href="index.html#heading-maximumpaths">StateMachine.MaximumPaths</a> (<a href="https://en.wikipedia.org/wiki/NP-hardness">NP-hard</a>), and <a href="index.html#heading-finddeadends">StateMachine.FindDeadEnds</a>.</p><p class="extensible-markdown">This documentation is generated from the extended Markdown documentation using <a href="https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown">Extensible Markdown</a>
+<p class="title">Zoo</p><p><a href="https://github.com/SAKryukov/generic-state-machine/tree/main/code/Tests/TestZoo">Source code</a></p><p>The Zoo example represents the state machine representing the visitor location at the zoo. This is the transition graph:</p><p><img src="zoo.svg" alt="Zoo" /></p><p>Note that all the transitions are <em>undirected</em> except the transition between Flamingo and Exit, because entering the zoo area using the exit is not allowed.</p><p>The example demonstrates valid transitions and the attempt to perform some invalid transitions. In particular, each attempt to enter the Chimpanzee area shows the message “Chimpanzee area is temporarily closed”.</p><p>The example also demonstrates <a href="index.html#heading-labyrinth">StateMachine.Labyrinth</a>, <a href="index.html#heading-longestpaths">StateMachine.LongestPaths</a> (<a href="https://en.wikipedia.org/wiki/NP-hardness">NP-hard</a>), <a href="index.html#heading-maximumpaths">StateMachine.MaximumPaths</a> (<a href="https://en.wikipedia.org/wiki/NP-hardness">NP-hard</a>), and <a href="index.html#heading-finddeadends">StateMachine.FindDeadEnds</a>.</p><p class="extensible-markdown">This documentation is generated from the extended Markdown documentation using <a href="https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown">Extensible Markdown</a>
 for Visual Studio Code.</p>
 
 </body>

diff --git a/docs/Example.Zoo.md b/docs/Example.Zoo.md
@@ -12,5 +12,4 @@ The example demonstrates valid transitions and the attempt to perform some inval
 
 The example also demonstrates [StateMachine.Labyrinth](index.html#heading-labyrinth), [StateMachine.LongestPaths](index.html#heading-longestpaths) ([NP-hard](https://en.wikipedia.org/wiki/NP-hardness)), [StateMachine.MaximumPaths](index.html#heading-maximumpaths) ([NP-hard](https://en.wikipedia.org/wiki/NP-hardness)), and [StateMachine.FindDeadEnds](index.html#heading-finddeadends).
 
-This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
-for Visual Studio Code.{.extensible-markdown}
+@include(extensible-markdown.md)
diff --git a/docs/extensible-markdown.md b/docs/extensible-markdown.md
@@ -0,0 +1,2 @@
+This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
+for Visual Studio Code.{.extensible-markdown}
diff --git a/docs/index.html b/docs/index.html
@@ -13,6 +13,9 @@
         p.toc br { content: ""; display: block; margin-top: 0.2em; }
         img { width: 70%; display: block; margin-left: auto; margin-right: auto; }
         p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        table, td { border: solid thin black; border-collapse: collapse; font-size: 120%; }
+        table { margin-left: 2em; }
+        td { width: 1.4em; text-align: center; vertical-align: middle; }
     </style>
 </head>
 <body>
@@ -108,8 +111,7 @@ <h2 id="heading-room-door-example">Room Door Example</h2>
 Also, the code can be used for some <a href="https://en.wikipedia.org/wiki/.NET_Framework">.NET Framework</a> versions. However, it will require re-creation of project files, which is not hard to do.</p><p>The build does not require Visual Studio, Visual Studio Code, or any other IDE. It can be done using the commands</p><pre>dotnet build -c Debug
 dotnet build -c Release
 </pre><p>With Visual Studio or Visual Studio Code, the code can be built in the usual ways. Besides, for Visual Studio Code, a <a href="https://github.com/SAKryukov/generic-state-machine/blob/main/code/.vscode/launch.json">launch configuration “Build All”</a> and a <a href="https://github.com/SAKryukov/generic-state-machine/blob/main/code/.vscode/tasks.json">task “Build All”</a> are provided.</p><p class="extensible-markdown">This documentation is generated from the extended Markdown documentation using <a href="https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown">Extensible Markdown</a>
-for Visual Studio Code.</p><div  data-line="239" class="code-line" dir="auto" ></div>
-<script src="https://SAKryukov.github.io/publications/code/source-code-decorator.js"></script>
+for Visual Studio Code.</p><script src="https://SAKryukov.github.io/publications/code/source-code-decorator.js"></script>
 
 
 </body>

diff --git a/docs/index.md b/docs/index.md
@@ -234,7 +234,6 @@ dotnet build -c Release
 
 With Visual Studio or Visual Studio Code, the code can be built in the usual ways. Besides, for Visual Studio Code, a [launch configuration "Build All"](https://github.com/SAKryukov/generic-state-machine/blob/main/code/.vscode/launch.json) and a [task "Build All"](https://github.com/SAKryukov/generic-state-machine/blob/main/code/.vscode/tasks.json) are provided.
 
-This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
-for Visual Studio Code.{.extensible-markdown}
+@include(extensible-markdown.md)
 
 <script src="https://SAKryukov.github.io/publications/code/source-code-decorator.js"></script>
diff --git a/docs/style.css b/docs/style.css
@@ -6,4 +6,7 @@
         p, h1, h2, h3, h4 { margin-top: 1em; margin-bottom: 0.4em; }
         p.toc br { content: ""; display: block; margin-top: 0.2em; }
         img { width: 70%; display: block; margin-left: auto; margin-right: auto; }
-        p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        p.extensible-markdown { border-top: solid thin darkgray; font-size: 80%; }
+        table, td { border: solid thin black; border-collapse: collapse; font-size: 120%; }
+        table { margin-left: 2em; }
+        td { width: 1.4em; text-align: center; vertical-align: middle; }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		This documentation is generated from the extended Markdown documentation using [Extensible Markdown](https://marketplace.visualstudio.com/items?itemName=sakryukov.extensible-markdown)
		for Visual Studio Code.{.extensible-markdown}