diff options
author | Olivier Roques <olivier@oroques.dev> | 2021-07-01 14:40:37 +0200 |
---|---|---|
committer | Olivier Roques <olivier@oroques.dev> | 2021-07-01 14:40:37 +0200 |
commit | dffd8e7ce72a1c3a66fcbca146eeab72a4fea43a (patch) | |
tree | 167258cf4d13269f17f392f4c9881d7d5620e2b4 | |
parent | dd49046de3ab3e51a5eb4b3df79dd50c4ea940f9 (diff) |
Improve KaTeX documentation
Closes #23
-rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -27,9 +27,24 @@ 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. +## KaTeX 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. +Hugo introduces tags when it sees newlines which breaks KaTeX block +environments. The theme has a `math` shortcode to circumvent this issue: +```md +{{< math >}} +\begin{pmatrix} +a & b \\ +c & d +\end{pmatrix} +{{< /math >}} +``` +Check [this +issue](https://github.com/ojroques/hugo-researcher/issues/1#issuecomment-697247056) +for more details. + ## License [GPL-3.0 License](https://github.com/ojroques/hugo-researcher/blob/master/LICENSE) |