https://github.com/ojroques/hugo-researcher
A simple resume theme for Hugo
https://github.com/ojroques/hugo-researcher
hugo-theme
Last synced: about 2 months ago
JSON representation
A simple resume theme for Hugo
- Host: GitHub
- URL: https://github.com/ojroques/hugo-researcher
- Owner: ojroques
- License: gpl-3.0
- Created: 2020-08-01T22:33:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-06T07:45:09.000Z (8 months ago)
- Last Synced: 2025-04-01T13:12:05.806Z (about 2 months ago)
- Topics: hugo-theme
- Language: HTML
- Homepage:
- Size: 378 KB
- Stars: 241
- Watchers: 6
- Forks: 133
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)