Skip to content

Commit 1aaa1bf

Browse files
nikoschamnikoscham
committed
Refactor HTML comments to standardize header information across multiple tutorial files
1 parent 0b36728 commit 1aaa1bf

12 files changed

+117
-163
lines changed

‎feascript-platform.html‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<!DOCTYPE html>
22

3-
<!-- -->
4-
<!-- ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ -->
5-
<!-- ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
6-
<!-- ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ -->
7-
<!-- ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
8-
<!-- ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
9-
<!-- ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
10-
<!-- ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ -->
11-
<!-- ↘↘ ↘↘ -->
12-
<!-- ↘↘ ↘↘ -->
13-
<!-- Website: https://feascript.com/ ↘↘ -->
14-
<!-- ↘↘↘ -->
3+
<!--
4+
════════════════════════════════════════════════════════════
5+
FEAScript Library
6+
Lightweight Finite Element Simulation in JavaScript
7+
Version: 0.1.4 | https://feascript.com
8+
════════════════════════════════════════════════════════════
9+
-->
1510

1611
<html>
1712
<head>

‎feascript-website.css‎

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,16 @@
1-
/* /*
2-
/* ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ /*
3-
/* ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ /*
4-
/* ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ /*
5-
/* ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ /*
6-
/* ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ /*
7-
/* ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ /*
8-
/* ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ /*
9-
/* ↘↘ ↘↘ /*
10-
/* ↘↘ ↘↘ /*
11-
/* Website: https://feascript.com/ ↘↘ /*
12-
/* ↘↘↘ /*
13-
14-
/* ==========================================================================
1+
/*
2+
════════════════════════════════════════════════════════════
3+
FEAScript Library
4+
Lightweight Finite Element Simulation in JavaScript
5+
Version: 0.1.4 | https://feascript.com
6+
════════════════════════════════════════════════════════════
7+
*/
8+
9+
/*
10+
════════════════════════════════════════════════════════════
1511
RESET AND BASE STYLES
16-
========================================================================== */
12+
════════════════════════════════════════════════════════════
13+
*/
1714
* {
1815
margin: 0;
1916
padding: 0;
@@ -34,9 +31,11 @@ body {
3431
line-height: 1.6;
3532
}
3633

37-
/* ==========================================================================
34+
/*
35+
════════════════════════════════════════════════════════════
3836
TYPOGRAPHY
39-
========================================================================== */
37+
════════════════════════════════════════════════════════════
38+
*/
4039
/* Headings */
4140
h1,
4241
h2,
@@ -76,9 +75,11 @@ a {
7675
text-decoration: none;
7776
}
7877

79-
/* ==========================================================================
78+
/*
79+
════════════════════════════════════════════════════════════
8080
LAYOUT COMPONENTS
81-
========================================================================== */
81+
════════════════════════════════════════════════════════════
82+
*/
8283
/* Banner */
8384
#banner {
8485
float: right;
@@ -136,9 +137,11 @@ footer {
136137
border-top: 2px solid #e0c97f;
137138
}
138139

139-
/* ==========================================================================
140+
/*
141+
════════════════════════════════════════════════════════════
140142
CONTENT ELEMENTS
141-
========================================================================== */
143+
════════════════════════════════════════════════════════════
144+
*/
142145
/* Lists */
143146
ul {
144147
padding-left: 1.5em;
@@ -176,9 +179,11 @@ mjx-container {
176179
text-align: left !important;
177180
}
178181

179-
/* ==========================================================================
182+
/*
183+
════════════════════════════════════════════════════════════
180184
SPECIAL COMPONENTS
181-
========================================================================== */
185+
════════════════════════════════════════════════════════════
186+
*/
182187
/* Highlight containers */
183188
.highlight-container {
184189
background: #f7e7b7;
@@ -325,20 +330,23 @@ mjx-container {
325330
margin-bottom: 1em;
326331
}
327332

328-
/* ==========================================================================
333+
/*
334+
════════════════════════════════════════════════════════════
329335
HELPER CLASSES AND UTILITIES
330-
========================================================================== */
331-
336+
════════════════════════════════════════════════════════════
337+
*/
332338
/* Notice bars */
333339
.notice-dev {
334340
border-left: 4px solid #f39c12;
335341
padding-left: 10px;
336342
margin: 1em 0;
337343
}
338344

339-
/* ==========================================================================
345+
/*
346+
════════════════════════════════════════════════════════════
340347
MEDIA QUERIES
341-
========================================================================== */
348+
════════════════════════════════════════════════════════════
349+
*/
342350
/* Small screens: up to 500px */
343351
@media screen and (max-width: 500px) {
344352
body {
@@ -447,9 +455,11 @@ mjx-container {
447455
}
448456
}
449457

450-
/* ==========================================================================
458+
/*
459+
════════════════════════════════════════════════════════════
451460
PLATFORM-SPECIFIC STYLES
452-
========================================================================== */
461+
════════════════════════════════════════════════════════════
462+
*/
453463
.platform-layout {
454464
background-color: transparent;
455465
margin: 0.5em 0;

‎index.html‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<!DOCTYPE html>
22

3-
<!-- -->
4-
<!-- ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ -->
5-
<!-- ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
6-
<!-- ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ -->
7-
<!-- ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
8-
<!-- ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
9-
<!-- ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
10-
<!-- ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ -->
11-
<!-- ↘↘ ↘↘ -->
12-
<!-- ↘↘ ↘↘ -->
13-
<!-- Website: https://feascript.com/ ↘↘ -->
14-
<!-- ↘↘↘ -->
3+
<!--
4+
════════════════════════════════════════════════════════════
5+
FEAScript Library
6+
Lightweight Finite Element Simulation in JavaScript
7+
Version: 0.1.4 | https://feascript.com
8+
════════════════════════════════════════════════════════════
9+
-->
1510

1611
<html>
1712
<head>

‎tutorials/advection-diffusion-1d.html‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<!DOCTYPE html>
22

3-
<!-- -->
4-
<!-- ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ -->
5-
<!-- ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
6-
<!-- ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ -->
7-
<!-- ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
8-
<!-- ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
9-
<!-- ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
10-
<!-- ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ -->
11-
<!-- ↘↘ ↘↘ -->
12-
<!-- ↘↘ ↘↘ -->
13-
<!-- Website: https://feascript.com/ ↘↘ -->
14-
<!-- ↘↘↘ -->
3+
<!--
4+
════════════════════════════════════════════════════════════
5+
FEAScript Library
6+
Lightweight Finite Element Simulation in JavaScript
7+
Version: 0.1.4 | https://feascript.com
8+
════════════════════════════════════════════════════════════
9+
-->
1510

1611
<html>
1712
<head>

‎tutorials/heat-conduction-1d-wall.html‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<!DOCTYPE html>
22

3-
<!-- -->
4-
<!-- ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ -->
5-
<!-- ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
6-
<!-- ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ -->
7-
<!-- ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
8-
<!-- ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
9-
<!-- ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
10-
<!-- ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ -->
11-
<!-- ↘↘ ↘↘ -->
12-
<!-- ↘↘ ↘↘ -->
13-
<!-- Website: https://feascript.com/ ↘↘ -->
14-
<!-- ↘↘↘ -->
3+
<!--
4+
════════════════════════════════════════════════════════════
5+
FEAScript Library
6+
Lightweight Finite Element Simulation in JavaScript
7+
Version: 0.1.4 | https://feascript.com
8+
════════════════════════════════════════════════════════════
9+
-->
1510

1611
<html>
1712
<head>

‎tutorials/heat-conduction-2d-fin-gmsh.html‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<!DOCTYPE html>
22

3-
<!-- -->
4-
<!-- ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ -->
5-
<!-- ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
6-
<!-- ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ -->
7-
<!-- ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
8-
<!-- ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
9-
<!-- ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
10-
<!-- ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ -->
11-
<!-- ↘↘ ↘↘ -->
12-
<!-- ↘↘ ↘↘ -->
13-
<!-- Website: https://feascript.com/ ↘↘ -->
14-
<!-- ↘↘↘ -->
3+
<!--
4+
════════════════════════════════════════════════════════════
5+
FEAScript Library
6+
Lightweight Finite Element Simulation in JavaScript
7+
Version: 0.1.4 | https://feascript.com
8+
════════════════════════════════════════════════════════════
9+
-->
1510

1611
<html lang="en">
1712
<head>

‎tutorials/heat-conduction-2d-fin-performance-test.html‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
<!DOCTYPE html>
22

3-
<!-- -->
4-
<!-- ↘↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘↘↘↘↘ ↘↘ -->
5-
<!-- ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
6-
<!-- ↘↘ ↘↘ ↘ ↘↘ ↘↘↘ ↘↘↘↘↘↘ ↘↘↘↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘ -->
7-
<!-- ↘↘↘↘↘↘↘↘ ↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
8-
<!-- ↘↘ ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
9-
<!-- ↘↘ ↘↘ ↘↘ ↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ ↘↘ -->
10-
<!-- ↘↘ ↘↘↘↘↘↘↘↘↘ ↘↘ ↘↘ ↘↘↘↘↘↘↘↘ ↘↘↘ ↘↘↘ ↘↘ ↘↘ ↘↘↘ ↘↘↘ ↘↘ -->
11-
<!-- ↘↘ ↘↘ -->
12-
<!-- ↘↘ ↘↘ -->
13-
<!-- Website: https://feascript.com/ ↘↘ -->
14-
<!-- ↘↘↘ -->
3+
<!--
4+
════════════════════════════════════════════════════════════
5+
FEAScript Library
6+
Lightweight Finite Element Simulation in JavaScript
7+
Version: 0.1.4 | https://feascript.com
8+
════════════════════════════════════════════════════════════
9+
-->
1510

1611
<html>
1712
<head>

0 commit comments

Comments
 (0)