Skip to content

Commit 9926ddb

Browse files
cdarve245cdarve245
committed
finish comments in documentation
1 parent a84a22b commit 9926ddb

File tree

7 files changed

+146
-40
lines changed

7 files changed

+146
-40
lines changed

‎documentation/rom_simulation.html‎

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,10 +43,11 @@
4243
};
4344
</script>
4445

45-
<script
46-
type="module"
47-
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
48+
type="module"
49+
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
50+
></script>
4951

5052
<!-- browser tab labels -->
5153
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,7 +150,10 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The second class after "skipTo" is the ID of the <span> element
156+
of the <zero-md> element that renders the markdown file -->
151157
<div>
152158
<h4 class="skipTo introduction">Introduction</h4>
153159
</div>
@@ -185,7 +191,15 @@ <h4 class="skipTo 0d-solver">0D Solver</h4>
185191
</div>
186192
</section>
187193

194+
<!-- The following code defines the place where the markdown files are rendered -->
188195
<section class="docsSection" style="float: right">
196+
<!-- To reference the section linked in the <zero-md> element,
197+
reference the ID in the <span> element -->
198+
199+
<!-- All markdown files must be named readme.md -->
200+
201+
<!-- The first <zero-md> element should have the id="math" attribute -->
202+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
189203
<span id="introduction">
190204
<zero-md id="math" src="rom_simulation/intro/readme.md" no-shadow></zero-md>
191205
</span>
@@ -255,7 +269,8 @@ <h4 class="skipTo 0d-solver">0D Solver</h4>
255269
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
256270
</section>
257271

258-
272+
<!-- The following code adds the Mathjax CDN to the html once it has been
273+
rendered by the markdown files -->
259274
<script>
260275
math.addEventListener('zero-md-rendered', () => {
261276
var el = document.createElement('script');

‎documentation/simcardio.html‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -30,8 +31,6 @@
3031
}
3132
</script>
3233

33-
34-
3534
<script>
3635
MathJax = {
3736
tex: {
@@ -43,6 +42,7 @@
4342
};
4443
</script>
4544

45+
<!-- This is the CDN that imports the code for the <zero-md> element -->
4646
<script
4747
type="module"
4848
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
@@ -77,6 +77,7 @@
7777
</div>
7878
</div>
7979
<div class="col-6 topRightBars">
80+
<!-- The following code defines the navigation bar in the header -->
8081
<div id="headerNavBar">
8182
<details>
8283
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -148,7 +149,10 @@
148149
</section>
149150

150151
<section class="mainSection">
152+
<!-- The following code defines the navigation section on the left of the page -->
151153
<section class="navigationSection" style="float: left">
154+
<!-- The second class after "skipTo" is the ID of the <span> element
155+
of the <zero-md> element that renders the markdown file -->
152156
<div>
153157
<h4 class="skipTo introduction">Introduction</h4>
154158
</div>
@@ -217,7 +221,15 @@ <h5 class="skipTo mechanics-refs">References</h5>
217221
</div>
218222
</section>
219223

224+
<!-- The following code defines the place where the markdown files are rendered -->
220225
<section class="docsSection" style="float: right">
226+
<!-- To reference the section linked in the <zero-md> element,
227+
reference the ID in the <span> element -->
228+
229+
<!-- All markdown files must be named readme.md -->
230+
231+
<!-- The first <zero-md> element should have the id="math" attribute -->
232+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
221233
<span id="introduction">
222234
<zero-md id="math" src="simcardio/intro/readme.md" no-shadow></zero-md>
223235
</span>
@@ -344,7 +356,8 @@ <h5 class="skipTo mechanics-refs">References</h5>
344356
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
345357
</section>
346358

347-
359+
<!-- The following code adds the Mathjax CDN to the html once it has been
360+
rendered by the markdown files -->
348361
<script>
349362
math.addEventListener('zero-md-rendered', () => {
350363
var el = document.createElement('script');

‎documentation/svfsi.html‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,14 +43,15 @@
4243
};
4344
</script>
4445

45-
<script
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
4648
type="module"
4749
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
50+
></script>
4951

50-
<!-- browser tab labels -->
51-
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
52-
<title>SimVascular Docs</title>
52+
<!-- browser tab labels -->
53+
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
54+
<title>SimVascular Docs</title>
5355

5456
<!-- Google Analytics Manager -->
5557
<script
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,7 +150,10 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The second class after "skipTo" is the ID of the <span> element
156+
of the <zero-md> element that renders the markdown file -->
151157
<div>
152158
<h4 class="skipTo introduction">Introduction</h4>
153159
</div>
@@ -176,7 +182,15 @@ <h4 class="skipTo install">Installation</h4>
176182
</div>
177183
</section>
178184

185+
<!-- The following code defines the place where the markdown files are rendered -->
179186
<section class="docsSection" style="float: right">
187+
<!-- To reference the section linked in the <zero-md> element,
188+
reference the ID in the <span> element -->
189+
190+
<!-- All markdown files must be named readme.md -->
191+
192+
<!-- The first <zero-md> element should have the id="math" attribute -->
193+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
180194
<span id="introduction">
181195
<zero-md id="math" src="svfsi/main/intro/readme.md" no-shadow></zero-md>
182196
</span>
@@ -214,7 +228,8 @@ <h4 class="skipTo install">Installation</h4>
214228
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
215229
</section>
216230

217-
231+
<!-- The following code adds the Mathjax CDN to the html once it has been
232+
rendered by the markdown files -->
218233
<script>
219234
math.addEventListener('zero-md-rendered', () => {
220235
var el = document.createElement('script');

‎documentation/svfsi_cep.html‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
24-
24+
25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,10 +43,11 @@
4243
};
4344
</script>
4445

45-
<script
46-
type="module"
47-
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
48+
type="module"
49+
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
50+
></script>
4951

5052
<!-- browser tab labels -->
5153
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,7 +150,10 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The second class after "skipTo" is the ID of the <span> element
156+
of the <zero-md> element that renders the markdown file -->
151157
<div>
152158
<h4 class="skipTo introduction">Introduction</h4>
153159
</div>
@@ -166,7 +172,15 @@ <h4 class="skipTo refs">References</h4>
166172
</div>
167173
</section>
168174

175+
<!-- The following code defines the place where the markdown files are rendered -->
169176
<section class="docsSection" style="float: right">
177+
<!-- To reference the section linked in the <zero-md> element,
178+
reference the ID in the <span> element -->
179+
180+
<!-- All markdown files must be named readme.md -->
181+
182+
<!-- The first <zero-md> element should have the id="math" attribute -->
183+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
170184
<span id="introduction">
171185
<zero-md id="math" src="svfsi/cep/intro/readme.md" no-shadow></zero-md>
172186
</span>
@@ -191,7 +205,8 @@ <h4 class="skipTo refs">References</h4>
191205
<p id="skipToTop"><i class="fa-solid fa-arrow-up"></i></p>
192206
</section>
193207

194-
208+
<!-- The following code adds the Mathjax CDN to the html once it has been
209+
rendered by the markdown files -->
195210
<script>
196211
math.addEventListener('zero-md-rendered', () => {
197212
var el = document.createElement('script');

‎documentation/svfsi_fluid.html‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,13 @@
1616
<!-- Bootstrap CSS -->
1717
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
1818

19-
<!-- Styles CSS -->
19+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2020
<link rel="stylesheet" href="../css/bootstrap.css">
2121
<link rel="stylesheet" href="../css/grayscale.css">
2222
<link rel="stylesheet" href="../css/standards.css">
2323
<link rel="stylesheet" href="../css/documentation.css">
2424

25+
<!-- This applies styling to the markdown that is generated with the <zero-md> element -->
2526
<script>
2627
window.ZeroMd = {
2728
config: {
@@ -42,10 +43,11 @@
4243
};
4344
</script>
4445

45-
<script
46-
type="module"
47-
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
48-
></script>
46+
<!-- This is the CDN that imports the code for the <zero-md> element -->
47+
<script
48+
type="module"
49+
src="https://cdn.jsdelivr.net/gh/zerodevx/zero-md@1/src/zero-md.min.js"
50+
></script>
4951

5052
<!-- browser tab labels -->
5153
<link rel="shortcut icon" type="image/jpg" href="../img/svlogo/svIcon.png"></link>
@@ -76,6 +78,7 @@
7678
</div>
7779
</div>
7880
<div class="col-6 topRightBars">
81+
<!-- The following code defines the navigation bar in the header -->
7982
<div id="headerNavBar">
8083
<details>
8184
<summary><i class="fa-solid fa-bars" id="iconForSkip"></i></summary>
@@ -147,7 +150,10 @@
147150
</section>
148151

149152
<section class="mainSection">
153+
<!-- The following code defines the navigation section on the left of the page -->
150154
<section class="navigationSection" style="float: left">
155+
<!-- The second class after "skipTo" is the ID of the <span> element
156+
of the <zero-md> element that renders the markdown file -->
151157
<div>
152158
<h4 class="skipTo introduction">Introduction</h4>
153159
</div>
@@ -170,8 +176,16 @@ <h4 class="skipTo ref">Reference</h4>
170176
</div>
171177
</section>
172178

179+
<!-- The following code defines the place where the markdown files are rendered -->
173180
<section class="docsSection" style="float: right">
174-
<span id="introduction">
181+
<!-- To reference the section linked in the <zero-md> element,
182+
reference the ID in the <span> element -->
183+
184+
<!-- All markdown files must be named readme.md -->
185+
186+
<!-- The first <zero-md> element should have the id="math" attribute -->
187+
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
188+
<span id="introduction">
175189
<zero-md id="math" src="svfsi/fluid/intro/readme.md" no-shadow></zero-md>
176190
</span>
177191
<span id="nn">
@@ -202,6 +216,8 @@ <h4 class="skipTo ref">Reference</h4>
202216
</section>
203217

204218

219+
<!-- The following code adds the Mathjax CDN to the html once it has been
220+
rendered by the markdown files -->
205221
<script>
206222
math.addEventListener('zero-md-rendered', () => {
207223
var el = document.createElement('script');

0 commit comments

Comments
 (0)