aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Freilich <sfreilich@google.com>2022-03-07 17:11:28 -0800
committerCopybara-Service <copybara-worker@google.com>2022-03-07 17:11:57 -0800
commit75152aed304ba9378fd527c226e9849ca39d5eda (patch)
tree2b04728ae0b5776a065051dd6784830f4f42563b
parent0b0d57895bbe4afaf1d77d0a22a599bb8012444b (diff)
downloadink-stroke-modeler-75152aed304ba9378fd527c226e9849ca39d5eda.tar.gz
Use MathJax rendering on GitHub pages
PiperOrigin-RevId: 433078561
-rw-r--r--README.md6
-rw-r--r--_config.yml2
-rw-r--r--_includes/head-custom.html8
3 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index c7ab9ca..c04c2fd 100644
--- a/README.md
+++ b/README.md
@@ -206,6 +206,12 @@ by the most recent call to `Predict`.
## Implementation Details
+<p class="hidden-in-github-pages">(<em>Note:</em> Mathematical formulas below
+are rendered with <a href="https://www.mathjax.org/">MathJax</a>, which GitHub's
+native Markdown rendering does not support. You can view the rendered version
+<a href="https://google.github.io/ink-stroke-modeler/#implementation-details">on
+GitHub pages</a>.)</p>
+
The design goals for this library were:
* Minimize overall latency.
diff --git a/_config.yml b/_config.yml
new file mode 100644
index 0000000..f507792
--- /dev/null
+++ b/_config.yml
@@ -0,0 +1,2 @@
+# GitHub Pages config
+theme: jekyll-theme-cayman
diff --git a/_includes/head-custom.html b/_includes/head-custom.html
new file mode 100644
index 0000000..32d666b
--- /dev/null
+++ b/_includes/head-custom.html
@@ -0,0 +1,8 @@
+<script type="text/javascript" async
+ src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-MML-AM_CHTML">
+</script>
+<style>
+.hidden-in-github-pages {
+ display: none;
+}
+</style>