aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOlivier Roques <olivier@oroques.dev>2020-09-22 21:51:35 +0200
committerOlivier Roques <olivier@oroques.dev>2020-09-22 21:51:35 +0200
commit09c2ed7f45b044543cb8d1fe49b720b8a1b6972d (patch)
treeebc1526103028bbbd6e9f2a89cd7671defdc1902 /README.md
parentae69b114acf36e7834ff9570ec67df44559251ee (diff)
Add KaTeX support
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 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)