mirror of
https://github.com/SqrtMinusOne/sqrtminusone.github.io.git
synced 2025-12-11 16:13:03 +03:00
50 lines
1.5 KiB
Markdown
50 lines
1.5 KiB
Markdown
# Researcher
|
|
|
|
A simple monospaced resume theme for Hugo. It was ported from Jekyll theme
|
|
[ankitsultana/researcher](https://github.com/ankitsultana/researcher).
|
|
|
|
## Screenshot
|
|
|
|
|
|
## 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
|
|
# if your website is not managed by git:
|
|
# git clone https://github.com/ojroques/hugo-researcher.git themes/researcher
|
|
```
|
|
|
|
Update the theme option in `config.toml`:
|
|
```toml
|
|
theme = "researcher"
|
|
```
|
|
|
|
## Configuration
|
|
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)
|