Auto-generated commit

stdlib-js · Mar 8, 2023 · 197566c · 197566c
1 parent 1df7234
commit 197566c
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 13 deletions.
diff --git a/.github/.keepalive b/.github/.keepalive
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -110,9 +110,9 @@ jobs:
             exit 0
           fi
           rm -rf ./bin/cli
-          rm test/test.cli.js
-          rm etc/cli_opts.json
-          rm docs/usage.txt
+          rm -f test/test.cli.js
+          rm -f etc/cli_opts.json
+          rm -f docs/usage.txt
 
           # For all dependencies, check in all *.js files if they are still used; if not, remove them:
           jq -r '.dependencies | keys[]' ./package.json | while read -r dep; do
@@ -149,6 +149,12 @@ jobs:
           # Add link definition for CLI package to README.md:
           find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/<section class=\"links\">/<section class=\"links\">\n\n[$escapedPkg]: https:\/\/www.npmjs.com\/package\/$escapedPkg/"
 
+      # Replace GitHub MathJax equations with SVGs:
+      - name: 'Replace GitHub MathJax equations with SVGs'
+        run: |
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g'
+          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/<!-- <div class="equation"(.*)(<\/div>\s*-->)/<div class="equation"$1<\/div>/sg'
+
       # Replace GitHub links to individual packages with npm links:
       - name: 'Replace all GitHub links to individual packages with npm links'
         run: |
@@ -162,8 +168,8 @@ jobs:
       # Remove unnecessary files:
       - name: 'Remove unnecessary files'
         run: |
-          rm docs/repl.txt
-          rm docs/types/test.ts
+          rm -f docs/repl.txt
+          rm -f docs/types/test.ts
 
       # Replace all stdlib GitHub dependencies with the respective npm packages:
       - name: 'Replace all stdlib GitHub dependencies with the respective npm packages'

diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -29,4 +29,5 @@ Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
 Shraddheya Shendre <shendreshraddheya@gmail.com>
 Stephannie Jiménez Gacha <steff456@hotmail.com>
 dorrin-sot <59933477+dorrin-sot@users.noreply.github.com>
+orimiles5 <97595296+orimiles5@users.noreply.github.com>
 rei2hu <rei2hu@users.noreply.github.com>
diff --git a/README.md b/README.md
@@ -30,32 +30,44 @@ For a window of size `W`, the [unbiased sample variance][sample-variance] is def
 
 <!-- <equation class="equation" label="eq:unbiased_sample_variance" align="center" raw="s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2" alt="Equation for the unbiased sample variance."> -->
 
-<div class="equation" align="center" data-raw-text="s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2" data-equation="eq:unbiased_sample_variance">
+```math
+s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2
+```
+
+<!-- <div class="equation" align="center" data-raw-text="s^2 = \frac{1}{W-1} \sum_{i=0}^{W-1} ( x_i - \bar{x} )^2" data-equation="eq:unbiased_sample_variance">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b331e5634fe726ff0e16e87814ac3f85d8164d31/lib/node_modules/@stdlib/stats/incr/mvmr/docs/img/equation_unbiased_sample_variance.svg" alt="Equation for the unbiased sample variance.">
     <br>
-</div>
+</div> -->
 
 <!-- </equation> -->
 
 and the [arithmetic mean][arithmetic-mean] is defined as
 
 <!-- <equation class="equation" label="eq:arithmetic_mean" align="center" raw="\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i" alt="Equation for the arithmetic mean."> -->
 
-<div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i" data-equation="eq:arithmetic_mean">
+```math
+\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i
+```
+
+<!-- <div class="equation" align="center" data-raw-text="\bar{x} = \frac{1}{W} \sum_{i=0}^{W-1} x_i" data-equation="eq:arithmetic_mean">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@164b8f1010c4535340eed9ad0b2af32c4a19863c/lib/node_modules/@stdlib/stats/incr/mvmr/docs/img/equation_arithmetic_mean.svg" alt="Equation for the arithmetic mean.">
     <br>
-</div>
+</div> -->
 
 <!-- </equation> -->
 
 The [variance-to-mean ratio][variance-to-mean-ratio] (VMR) is thus defined as
 
 <!-- <equation class="equation" label="eq:variance_to_mean_ratio" align="center" raw="F = \frac{s^2}{\bar{x}}" alt="Equation for the variance-to-mean ratio (VMR)."> -->
 
-<div class="equation" align="center" data-raw-text="F = \frac{s^2}{\bar{x}}" data-equation="eq:variance_to_mean_ratio">
+```math
+F = \frac{s^2}{\bar{x}}
+```
+
+<!-- <div class="equation" align="center" data-raw-text="F = \frac{s^2}{\bar{x}}" data-equation="eq:variance_to_mean_ratio">
     <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@b331e5634fe726ff0e16e87814ac3f85d8164d31/lib/node_modules/@stdlib/stats/incr/mvmr/docs/img/equation_variance_to_mean_ratio.svg" alt="Equation for the variance-to-mean ratio (VMR).">
     <br>
-</div>
+</div> -->
 
 <!-- </equation> -->
 
@@ -263,7 +275,7 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib