aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md7
-rw-r--r--exampleSite/config.toml3
-rw-r--r--layouts/_default/baseof.html3
-rw-r--r--layouts/partials/math.html3
4 files changed, 15 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7b59083..af775d2 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,9 @@ A simple monospaced resume theme for Hugo. It was ported from Jekyll theme
![thumbnail](https://github.com/ojroques/hugo-researcher/blob/master/images/tn.png)
## Installation
+This theme uses Sass to generate CSS files so make sure you have the
+*extended* Hugo version installed.
+
Add the theme to your site's `themes` directory:
```bash
git submodule add https://github.com/ojroques/hugo-researcher.git themes/researcher
@@ -22,5 +25,9 @@ A self-explanatory configuration file is present in
[exampleSite/config.toml](https://github.com/ojroques/hugo-researcher/blob/master/exampleSite/config.toml),
along the files of a demo website.
+You can enable [KaTeX](https://katex.org/) (math typesetting) by including
+`math: true` in your content files. Or you can enable it globally by setting
+`math` to `true` in your project config.
+
## License
[GPL-3.0 License](https://github.com/ojroques/hugo-researcher/blob/master/LICENSE)
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index e794482..602ea15 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -3,11 +3,12 @@ baseURL = "https://example.com"
theme = "researcher"
disableKinds = ["taxonomy", "term", "RSS", "sitemap", "robotsTXT"]
enableEmoji = true
+math = false # enable KaTeX (https://katex.org/) globally
[params]
author = "Olivier Roques"
description = "A simple monospaced resume theme for Hugo."
- favicon = "favicon.ico"
+ favicon = "favicon.ico" # path to a .ico to use as favicon
[params.footer]
text = "By Olivier Roques"
url = "https://github.com/ojroques/hugo-researcher"
diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
index 5f8e2ec..86eee86 100644
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -1,6 +1,9 @@
<!DOCTYPE html>
<html>
{{- partial "head.html" . -}}
+ {{ if or .Params.math .Site.Params.math }}
+ {{- partial "math.html" . -}}
+ {{ end }}
<body>
{{- partial "header.html" . -}}
<div id="content">
diff --git a/layouts/partials/math.html b/layouts/partials/math.html
new file mode 100644
index 0000000..94a1ae3
--- /dev/null
+++ b/layouts/partials/math.html
@@ -0,0 +1,3 @@
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.css" integrity="sha384-AfEj0r4/OFrOo5t7NnNe46zW/tFgW6x/bCJG8FqQCEo3+Aro6EYUG4+cU+KJWu/X" crossorigin="anonymous">
+<script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/katex.min.js" integrity="sha384-g7c+Jr9ZivxKLnZTDUhnkOnsh30B4H0rpLUpJ4jAIKs4fnJI+sEnkvrMWph2EDg4" crossorigin="anonymous"></script>
+<script defer src="https://cdn.jsdelivr.net/npm/katex@0.12.0/dist/contrib/auto-render.min.js" integrity="sha384-mll67QQFJfxn0IYznZYonOWZ644AWYC+Pt2cHqMaRhXVrursRwvLnLaebdGIlYNa" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>