From 09c2ed7f45b044543cb8d1fe49b720b8a1b6972d Mon Sep 17 00:00:00 2001 From: Olivier Roques Date: Tue, 22 Sep 2020 21:51:35 +0200 Subject: Add KaTeX support --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'README.md') 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) -- cgit v1.2.3