Skip to content

Commit b5f2295

Browse files
amykyta3amykyta3
committed
Add support for Markdown-Math rendering via MathJax
1 parent fcabb73 commit b5f2295

15 files changed

+99
-30
lines changed

‎docs/content/412630b3a91f7ea765ffa0eeba25b16835c7c1c8.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1 id="_Content.name">control</h1>
99
<dt>Base Offset:</dt><dd class="address">0x0</dd>
1010
<dt>Size:</dt><dd class="address">0x4</dd>
1111

12-
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L88" target="_blank">turboencabulator.rdl</a></dd>
12+
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L110" target="_blank">turboencabulator.rdl</a></dd>
1313

1414
</dl>
1515

‎docs/content/488855a74f22fc1aa2cd6cf049da8eb199c1e4e0.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1 id="_Content.name">status</h1>
99
<dt>Base Offset:</dt><dd class="address">0x4</dd>
1010
<dt>Size:</dt><dd class="address">0x4</dd>
1111

12-
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L93" target="_blank">turboencabulator.rdl</a></dd>
12+
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L115" target="_blank">turboencabulator.rdl</a></dd>
1313

1414
</dl>
1515

‎docs/content/603b3c9e17f0f001fdeb6db0c927d10c54aef359.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1 id="_Content.name">Encabulator Status</h1>
99
<dt>Base Offset:</dt><dd class="address">0x4</dd>
1010
<dt>Size:</dt><dd class="address">0x4</dd>
1111

12-
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L50" target="_blank">turboencabulator.rdl</a></dd>
12+
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L72" target="_blank">turboencabulator.rdl</a></dd>
1313

1414
</dl>
1515

‎docs/content/a6a30b3b34a1d783d8ad663c00b724b53ab19ddb.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ <h1 id="_Content.name">Grammeter measurement register</h1>
99
<dt>Base Offset:</dt><dd class="address">0x8</dd>
1010
<dt>Size:</dt><dd class="address">0x4</dd>
1111

12-
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L130" target="_blank">turboencabulator.rdl</a></dd>
12+
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L152" target="_blank">turboencabulator.rdl</a></dd>
1313

1414
</dl>
1515

‎docs/content/c8ecd471938a995bddc553e621dcd61f7562190a.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ <h1 id="_Content.name">System Control Register</h1>
1212
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L26" target="_blank">turboencabulator.rdl</a></dd>
1313

1414
</dl>
15+
<h2>Description</h2>
16+
<div id="_Content.desc">
17+
<div class="admonition tip">
18+
<p class="admonition-title">Tip</p>
19+
<p>This page demonstrates the use of the Markdown Math plugin to insert
20+
LaTeX-style equations that are rendered using MathJax.</p>
21+
<p>For inline math, use <code>\(...\)</code>.</p>
22+
<p>For standalone math blocks, use <code>$$...$$</code>, <code>\[...\]</code> or <code>\begin...\end</code>.</p>
23+
<p>Reminder: In RDL strings, backslashes need to be escaped.</p>
24+
</div>
25+
<p>&nbsp;</p>
26+
</div>
1527

1628
<h2>Contents</h2>
1729
<table border="1">
@@ -110,12 +122,20 @@ <h3 id="diractance.desc">diractance - Capactive diractance
110122
</h3>
111123
<div id="_Content.diractance.desc">
112124
<p>Capacitive diractance relative to the lunar waneshaft.</p>
125+
<p>The amount of energy that can be stored in a capacitor is <span><span class="MathJax_Preview">\(E = \frac{1}{2} CV^2\)</span><script type="math/tex">E = \frac{1}{2} CV^2</script></span>,
126+
but that is irrelevant because nobody knows what 'diractance' is, so we'll leave
127+
that as an exercise to the reader.</p>
113128
</div>
114129

115130
<h3 id="reluctance.desc">reluctance - Magneto-reluctance
116131
<a class="headerlink" href="#reluctance.desc" title="Permalink to this headline"></a>
117132
</h3>
118133
<div id="_Content.reluctance.desc">
119134
<p>Set the absolute magneto-reluctance.</p>
135+
<p>The definition of magnetic reluctance is:</p>
136+
<p>
137+
<div><span class="MathJax_Preview">$$\mathcal{R} = \frac{l}{\mu_0 \mu_r A} = \frac{l}{\mu A}$$</span><script type="math/tex; mode=display">\mathcal{R} = \frac{l}{\mu_0 \mu_r A} = \frac{l}{\mu A}</script>
138+
</div>
139+
</p>
120140
</div>
121141
</div>

‎docs/content/cea133aae92eaedf40c005f4812364671a5a681a.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ <h1 id="_Content.name">Cardinal Grammeter</h1>
1212
<dt>Array Stride:</dt><dd>+0x200</dd>
1313
<dt>Total Size:</dt><dd class="address">0x1800</dd>
1414

15-
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L66" target="_blank">turboencabulator.rdl</a></dd>
15+
<dt>Source:</dt><dd><a href="https://github.com/SystemRDL/PeakRDL-html/blob/master/example/turboencabulator.rdl#L88" target="_blank">turboencabulator.rdl</a></dd>
1616

1717
</dl>
1818
<h2>Description</h2>
@@ -33,7 +33,8 @@ <h2>Description</h2>
3333
<ul>
3434
<li>Absolute address is re-calculated</li>
3535
<li>URL crumbtrail is updated</li>
36-
<li>RDLFormatCode [index] tags are updated</li>
36+
<li>RDLFormatCode <div><span class="MathJax_Preview">\[index\]</span><script type="math/tex; mode=display">index</script>
37+
</div> tags are updated</li>
3738
</ul>
3839
</div>
3940
</div>

‎docs/index.html

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,35 @@
99
<style>
1010
html{box-sizing:border-box}*,*:before,*:after{box-sizing:inherit}
1111
</style>
12-
<link rel="stylesheet" href="css/normalize.css?v=2.3.1">
13-
<link rel="stylesheet" href="css/layout.css?v=2.3.1">
14-
<link rel="stylesheet" href="css/theme.css?v=2.3.1">
12+
<link rel="stylesheet" href="css/normalize.css?v=2.4.0">
13+
<link rel="stylesheet" href="css/layout.css?v=2.4.0">
14+
<link rel="stylesheet" href="css/theme.css?v=2.4.0">
1515
<link rel="icon" type="image/png" href="favicon.png">
1616
<script>
17-
var BUILD_TS = 1652845154;
17+
var BUILD_TS = 1652848867;
1818
</script>
19-
<script src="js/BigInteger.min.js?v=2.3.1" type="text/javascript"></script>
20-
<script src="js/sha1.js?v=2.3.1" type="text/javascript"></script>
21-
<script src="js/data.js?ts=1652845154" type="text/javascript"></script>
22-
<script src="search/bkt_index.js?ts=1652845154" type="text/javascript"></script>
23-
<script src="js/ral.js?v=2.3.1" type="text/javascript"></script>
24-
<script src="js/main.js?v=2.3.1" type="text/javascript"></script>
25-
<script src="js/nav.js?v=2.3.1" type="text/javascript"></script>
26-
<script src="js/sidebar.js?v=2.3.1" type="text/javascript"></script>
27-
<script src="js/index_edit.js?v=2.3.1" type="text/javascript"></script>
28-
<script src="js/field_testers.js?v=2.3.1" type="text/javascript"></script>
29-
<script src="js/search.js?v=2.3.1" type="text/javascript"></script>
30-
<script src="js/address_search.js?v=2.3.1" type="text/javascript"></script>
31-
<script src="js/path_search.js?v=2.3.1" type="text/javascript"></script>
32-
<script src="js/content_search.js?v=2.3.1" type="text/javascript"></script>
19+
<script async src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
20+
<script type="text/x-mathjax-config">
21+
MathJax.Hub.Config({
22+
config: ["MMLorHTML.js"],
23+
jax: ["input/TeX", "output/HTML-CSS", "output/NativeMML"],
24+
extensions: ["MathMenu.js", "MathZoom.js"]
25+
});
26+
</script>
27+
<script src="js/BigInteger.min.js?v=2.4.0" type="text/javascript"></script>
28+
<script src="js/sha1.js?v=2.4.0" type="text/javascript"></script>
29+
<script src="js/data.js?ts=1652848867" type="text/javascript"></script>
30+
<script src="search/bkt_index.js?ts=1652848867" type="text/javascript"></script>
31+
<script src="js/ral.js?v=2.4.0" type="text/javascript"></script>
32+
<script src="js/main.js?v=2.4.0" type="text/javascript"></script>
33+
<script src="js/nav.js?v=2.4.0" type="text/javascript"></script>
34+
<script src="js/sidebar.js?v=2.4.0" type="text/javascript"></script>
35+
<script src="js/index_edit.js?v=2.4.0" type="text/javascript"></script>
36+
<script src="js/field_testers.js?v=2.4.0" type="text/javascript"></script>
37+
<script src="js/search.js?v=2.4.0" type="text/javascript"></script>
38+
<script src="js/address_search.js?v=2.4.0" type="text/javascript"></script>
39+
<script src="js/path_search.js?v=2.4.0" type="text/javascript"></script>
40+
<script src="js/content_search.js?v=2.4.0" type="text/javascript"></script>
3341
</head>
3442

3543
<body class="pack-h" onload="onPageLoad()">
@@ -83,7 +91,7 @@
8391
<div class="main stretchy limit-h"></div>
8492
<footer class="main limit-h">
8593
<hr/>
86-
Generated by PeakRDL-html v2.3.1
94+
Generated by PeakRDL-html v2.4.0
8795
</footer>
8896
</div>
8997

‎docs/js/nav.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ async function load_page(id) {
1616
init_reg_value();
1717
init_radix_buttons();
1818
}
19+
//MathJax.Hub.Queue(["Typeset", MathJax.Hub, main_el]);
20+
MathJax.Hub.Queue(["Typeset", MathJax.Hub]);
1921
userHooks.onContentLoad();
2022
})
2123
.catch(e => {

‎docs/search/bkt-0.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"aut":[["automatic",[[5,6]]],["automatically",[[3,0]]],["automation",[[0,0]]]],"rel":[["relative",[[1,18]]],["reliable",[[3,0]]],["reluctance",[[1,11],[1,10]]]],"gen":[["generated",[[0,0]]],["generator",[[0,0]]]],"sti":[["sticky",[[5,10]]]],"cli":[["clicking",[[3,0]]]],"dif":[["differential",[[5,6],[2,2]]]],"jpg":[["jpg",[[0,0]]]],"dir":[["diractance",[[1,18],[1,19]]]],"enu":[["enum",[[5,2]]],["enumerated",[[5,2]]]],"lun":[["lunar",[[1,18]]]],"wan":[["waneshaft",[[1,18],[2,2]]]],"inc":[["include",[[5,2]]]],"des":[["desc",[[0,0]]],["description",[[5,2],[0,0]]]],"htm":[["html",[[0,0]]]],"ret":[["retro",[[0,0]]]],"out":[["output",[[0,0]]]],"deg":[["degree",[[2,2]]]],"din":[["dingle",[[3,0]]]],"lik":[["likely",[[5,6]]]],"cha":[["changed",[[3,0]]]],"ent":[["entropic",[[3,0]]]],"spa":[["space",[[0,0]]]],"art":[["art",[[0,0]]]],"cal":[["calculated",[[3,0]]]],"fea":[["features",[[3,0],[0,0]]]],"rec":[["recommended",[[0,0]]]],"exa":[["example",[[0,0]]]],"rdl":[["rdlformatcode",[[3,0],[0,0]]]],"abo":[["above",[[3,0]]]],"rep":[["represents",[[3,0]]]],"abs":[["absolute",[[1,10],[3,0]]]],"gir":[["girdle",[[2,2]]],["girdlespring",[[5,6]]]],"sta":[["state",[[5,3],[5,2],[5,6],[0,0]]],["stator",[[2,11],[5,6]]],["status",[[2,1],[0,0]]]],"suf":[["sufficient",[[0,0]]]],"mor":[["more",[[0,0]]]],"fiv":[["five",[[3,0]]]],"ind":[["independent",[[3,0]]],["index",[[3,0]]],["indicates",[[5,2]]],["indicating",[[5,10]]]],"foo":[["foot",[[6,2]]]],"amp":[["amperes",[[6,2]]]],"spr":[["spring",[[2,2]]]],"pag":[["page",[[3,0]]],["pages",[[0,0]]]],"enc":[["encabulator",[[0,1],[2,1],[3,0],[0,0]]],["encoding",[[5,2]]]],"url":[["url",[[3,0]]]],"inv":[["inverse",[[0,0]]]],"enh":[["enhanced",[[0,0]]]],"pri":[["prior",[[0,0]]]],"eac":[["each",[[3,0]]]],"mar":[["markdown",[[0,0]]]],"def":[["definition",[[5,2]]]],"sys":[["system",[[1,1]]],["systemrdl",[[0,0]]]],"add":[["address",[[3,0],[0,0]]]],"cru":[["crumbtrail",[[3,0]]]],"tra":[["training",[[0,0]]]],"bri":[["brief",[[0,0]]]],"sup":[["supply",[[0,0]]]],"rea":[["reactive",[[0,0]]],["reads",[[2,2]]],["ready",[[5,6],[5,7]]]],"dem":[["demo",[[0,0]]]],"hig":[["highlights",[[0,0]]]],"use":[["used",[[5,6]]],["users",[[0,0]]],["uses",[[5,2]]]],"loo":[["look",[[0,0]]]],"arr":[["array",[[3,0]]]],"alo":[["alongside",[[5,2]]]],"err":[["error",[[5,6]]]],"wat":[["watch",[[0,0]]]],"fum":[["fumbling",[[2,2]]]],"non":[["non",[[2,2]]]],"pos":[["position",[[5,6]]]],"per":[["per",[[6,2],[2,11]]]],"zer":[["zero",[[2,2]]]],"com":[["components",[[3,0]]]],"als":[["also",[[5,2],[0,0]]]],"ins":[["instance",[[3,0]]]],"suc":[["successfully",[[5,6]]]],"doc":[["documentation",[[0,0]]]],"sou":[["source",[[0,0]]]],"pea":[["peakrdl",[[0,0]]]],"cap":[["capacitive",[[1,18]]],["capactive",[[1,19]]]],"roc":[["rockwell",[[0,0]]]],"tip":[["tip",[[5,2],[3,0],[0,0]]]],"str":[["strongly",[[0,0]]],["structure",[[0,0]]]],"fol":[["following",[[3,0]]]],"imm":[["immediately",[[2,2]]]],"any":[["any",[[5,2]]]],"ful":[["fully",[[3,0]]]],"arm":[["arms",[[3,0]]]],"ten":[["tension",[[2,2]]]],"mon":[["month",[[2,11]]]],"vid":[["video",[[0,0]]]],"red":[["reduce",[[2,2]]]],"lit":[["liter",[[6,2]]]],"sub":[["substitute",[[0,0]]]],"uni":[["units",[[6,2]]]],"mea":[["measurement",[[6,1],[6,2]]],["measurements",[[3,0]]]],"res":[["reset",[[5,6],[5,7]]]],"upd":[["updated",[[3,0]]]],"bit":[["bit",[[5,10]]]],"fai":[["fail",[[5,7]]],["failed",[[5,10]]]],"rev":[["revolutions",[[2,11]]]],"car":[["cardinal",[[3,1],[5,2],[3,0]]]],"sid":[["side",[[2,2]]]],"whe":[["whether",[[5,10]]]],"fie":[["field",[[5,2]]]],"gra":[["grammeter",[[6,2],[3,1],[6,1],[3,0],[5,6],[5,3],[5,2]]],["grammeters",[[3,0]]]],"tex":[["text",[[0,0]]]],"twe":[["twelve",[[3,0]]]],"syn":[["sync",[[5,10],[5,7]]],["sync_fail",[[5,7]]],["synchronization",[[5,6]]],["synchronized",[[5,6]]],["synchronizing",[[3,0]]],["syntax",[[0,0]]]],"con":[["configuration",[[0,0]]],["contains",[[3,0]]],["content",[[0,0]]],["control",[[1,1]]]],"thr":[["throughout",[[0,0]]]],"reg":[["regfile",[[3,0]]],["register",[[6,1],[1,1],[0,0]]]],"not":[["notice",[[3,0]]]],"set":[["set",[[1,10]]]],"tag":[["tags",[[3,0],[0,0]]]],"tur":[["turbo",[[0,1],[3,0],[0,0]]]],"att":[["attempting",[[0,0]]]],"usi":[["using",[[0,0]]]],"cur":[["current",[[6,2],[3,0],[0,0]]]],"mag":[["magneto",[[1,11],[1,10]]]],"box":[["boxes",[[0,0]]]],"pro":[["produces",[[3,0]]],["product",[[0,0]]],["progress",[[5,6]]],["properties",[[0,0]]]]}
1+
{"aut":[["automatic",[[5,6]]],["automatically",[[3,0]]],["automation",[[0,0]]]],"sty":[["style",[[1,0]]]],"rel":[["relative",[[1,18]]],["reliable",[[3,0]]],["reluctance",[[1,11],[1,10]]]],"gen":[["generated",[[0,0]]],["generator",[[0,0]]]],"sti":[["sticky",[[5,10]]]],"cli":[["clicking",[[3,0]]]],"dif":[["differential",[[5,6],[2,2]]]],"equ":[["equations",[[1,0]]]],"jpg":[["jpg",[[0,0]]]],"dir":[["diractance",[[1,18],[1,19]]]],"enu":[["enum",[[5,2]]],["enumerated",[[5,2]]]],"lun":[["lunar",[[1,18]]]],"kno":[["knows",[[1,18]]]],"bac":[["backslashes",[[1,0]]]],"inl":[["inline",[[1,0]]]],"wan":[["waneshaft",[[1,18],[2,2]]]],"inc":[["include",[[5,2]]]],"des":[["desc",[[0,0]]],["description",[[5,2],[0,0]]]],"htm":[["html",[[0,0]]]],"ret":[["retro",[[0,0]]]],"out":[["output",[[0,0]]]],"sto":[["stored",[[1,18]]]],"blo":[["blocks",[[1,0]]]],"deg":[["degree",[[2,2]]]],"din":[["dingle",[[3,0]]]],"nee":[["need",[[1,0]]]],"lik":[["likely",[[5,6]]]],"cha":[["changed",[[3,0]]]],"exe":[["exercise",[[1,18]]]],"ent":[["entropic",[[3,0]]]],"spa":[["space",[[0,0]]]],"mat":[["math",[[1,0]]],["mathcal",[[1,10]]],["mathjax",[[1,0]]]],"art":[["art",[[0,0]]]],"cal":[["calculated",[[3,0]]]],"fea":[["features",[[3,0],[0,0]]]],"rec":[["recommended",[[0,0]]]],"exa":[["example",[[0,0]]]],"rdl":[["rdl",[[1,0]]],["rdlformatcode",[[3,0],[0,0]]]],"mu_":[["mu_0",[[1,10]]],["mu_r",[[1,10]]]],"abo":[["above",[[3,0]]]],"rep":[["represents",[[3,0]]]],"abs":[["absolute",[[1,10],[3,0]]]],"ren":[["rendered",[[1,0]]]],"bec":[["because",[[1,18]]]],"beg":[["begin",[[1,0]]]],"gir":[["girdle",[[2,2]]],["girdlespring",[[5,6]]]],"sta":[["standalone",[[1,0]]],["state",[[5,3],[5,2],[5,6],[0,0]]],["stator",[[2,11],[5,6]]],["status",[[2,1],[0,0]]]],"suf":[["sufficient",[[0,0]]]],"mor":[["more",[[0,0]]]],"fiv":[["five",[[3,0]]]],"ind":[["independent",[[3,0]]],["index",[[3,0]]],["indicates",[[5,2]]],["indicating",[[5,10]]]],"foo":[["foot",[[6,2]]]],"amp":[["amperes",[[6,2]]]],"spr":[["spring",[[2,2]]]],"pag":[["page",[[1,0],[3,0]]],["pages",[[0,0]]]],"enc":[["encabulator",[[0,1],[2,1],[3,0],[0,0]]],["encoding",[[5,2]]]],"url":[["url",[[3,0]]]],"inv":[["inverse",[[0,0]]]],"enh":[["enhanced",[[0,0]]]],"pri":[["prior",[[0,0]]]],"eac":[["each",[[3,0]]]],"mar":[["markdown",[[1,0],[0,0]]]],"plu":[["plugin",[[1,0]]]],"def":[["definition",[[1,10],[5,2]]]],"sys":[["system",[[1,1]]],["systemrdl",[[0,0]]]],"add":[["address",[[3,0],[0,0]]]],"cru":[["crumbtrail",[[3,0]]]],"nob":[["nobody",[[1,18]]]],"tra":[["training",[[0,0]]]],"bri":[["brief",[[0,0]]]],"sup":[["supply",[[0,0]]]],"rea":[["reactive",[[0,0]]],["reader",[[1,18]]],["reads",[[2,2]]],["ready",[[5,6],[5,7]]]],"dem":[["demo",[[0,0]]],["demonstrates",[[1,0]]]],"hig":[["highlights",[[0,0]]]],"use":[["used",[[5,6]]],["users",[[0,0]]],["uses",[[5,2]]]],"fra":[["frac",[[1,18],[1,10]]]],"loo":[["look",[[0,0]]]],"arr":[["array",[[3,0]]]],"alo":[["alongside",[[5,2]]]],"err":[["error",[[5,6]]]],"wat":[["watch",[[0,0]]]],"fum":[["fumbling",[[2,2]]]],"non":[["non",[[2,2]]]],"pos":[["position",[[5,6]]]],"per":[["per",[[6,2],[2,11]]]],"zer":[["zero",[[2,2]]]],"com":[["components",[[3,0]]]],"als":[["also",[[5,2],[0,0]]]],"ins":[["insert",[[1,0]]],["instance",[[3,0]]]],"suc":[["successfully",[[5,6]]]],"doc":[["documentation",[[0,0]]]],"sou":[["source",[[0,0]]]],"nbs":[["nbsp",[[1,0]]]],"pea":[["peakrdl",[[0,0]]]],"lea":[["leave",[[1,18]]]],"cap":[["capacitive",[[1,18]]],["capacitor",[[1,18]]],["capactive",[[1,19]]]],"ene":[["energy",[[1,18]]]],"roc":[["rockwell",[[0,0]]]],"tip":[["tip",[[1,0],[5,2],[3,0],[0,0]]]],"str":[["strings",[[1,0]]],["strongly",[[0,0]]],["structure",[[0,0]]]],"fol":[["following",[[3,0]]]],"imm":[["immediately",[[2,2]]]],"any":[["any",[[5,2]]]],"ful":[["fully",[[3,0]]]],"esc":[["escaped",[[1,0]]]],"arm":[["arms",[[3,0]]]],"ten":[["tension",[[2,2]]]],"mon":[["month",[[2,11]]]],"vid":[["video",[[0,0]]]],"red":[["reduce",[[2,2]]]],"lit":[["liter",[[6,2]]]],"lat":[["latex",[[1,0]]]],"sub":[["substitute",[[0,0]]]],"irr":[["irrelevant",[[1,18]]]],"uni":[["units",[[6,2]]]],"mea":[["measurement",[[6,1],[6,2]]],["measurements",[[3,0]]]],"res":[["reset",[[5,6],[5,7]]]],"rem":[["reminder",[[1,0]]]],"upd":[["updated",[[3,0]]]],"bit":[["bit",[[5,10]]]],"fai":[["fail",[[5,7]]],["failed",[[5,10]]]],"rev":[["revolutions",[[2,11]]]],"car":[["cardinal",[[3,1],[5,2],[3,0]]]],"sid":[["side",[[2,2]]]],"whe":[["whether",[[5,10]]]],"fie":[["field",[[5,2]]]],"gra":[["grammeter",[[6,2],[3,1],[6,1],[3,0],[5,6],[5,3],[5,2]]],["grammeters",[[3,0]]]],"tex":[["text",[[0,0]]]],"twe":[["twelve",[[3,0]]]],"syn":[["sync",[[5,10],[5,7]]],["sync_fail",[[5,7]]],["synchronization",[[5,6]]],["synchronized",[[5,6]]],["synchronizing",[[3,0]]],["syntax",[[0,0]]]],"con":[["configuration",[[0,0]]],["contains",[[3,0]]],["content",[[0,0]]],["control",[[1,1]]]],"thr":[["throughout",[[0,0]]]],"reg":[["regfile",[[3,0]]],["register",[[6,1],[1,1],[0,0]]]],"not":[["notice",[[3,0]]]],"set":[["set",[[1,10]]]],"tag":[["tags",[[3,0],[0,0]]]],"amo":[["amount",[[1,18]]]],"tur":[["turbo",[[0,1],[3,0],[0,0]]]],"end":[["end",[[1,0]]]],"att":[["attempting",[[0,0]]]],"usi":[["using",[[1,0],[0,0]]]],"cur":[["current",[[6,2],[3,0],[0,0]]]],"mag":[["magnetic",[[1,10]]],["magneto",[[1,11],[1,10]]]],"box":[["boxes",[[0,0]]]],"pro":[["produces",[[3,0]]],["product",[[0,0]]],["progress",[[5,6]]],["properties",[[0,0]]]]}

‎example/turboencabulator.rdl

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ addrmap turbo_encab {
2525
";
2626
reg {
2727
name = "System Control Register";
28+
desc = "
29+
!!! tip
30+
This page demonstrates the use of the Markdown Math plugin to insert
31+
LaTeX-style equations that are rendered using MathJax.
32+
33+
For inline math, use `\\(...\\)`.
34+
35+
For standalone math blocks, use `$$...$$`, `\\[...\\]` or `\\begin...\\end`.
36+
37+
Reminder: In RDL strings, backslashes need to be escaped.
38+
39+
&nbsp;
40+
";
41+
2842
field {
2943
sw=rw; hw=r;
3044
} reset;
@@ -33,6 +47,10 @@ addrmap turbo_encab {
3347
name = "Magneto-reluctance";
3448
desc = "
3549
Set the absolute magneto-reluctance.
50+
51+
The definition of magnetic reluctance is:
52+
53+
$$\\mathcal{R} = \\frac{l}{\\mu_0 \\mu_r A} = \\frac{l}{\\mu A}$$
3654
";
3755
sw=rw; hw=r;
3856
} reluctance[8] = 0x42;
@@ -41,6 +59,10 @@ addrmap turbo_encab {
4159
name = "Capactive diractance";
4260
desc = "
4361
Capacitive diractance relative to the lunar waneshaft.
62+
63+
The amount of energy that can be stored in a capacitor is \\(E = \\frac{1}{2} CV^2\\),
64+
but that is irrelevant because nobody knows what 'diractance' is, so we'll leave
65+
that as an exercise to the reader.
4466
";
4567
sw=rw; hw=r;
4668
} diractance[8];

‎peakrdl/html/__about__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "2.3.1"
1+
__version__ = "2.4.0"

0 commit comments

Comments
 (0)