diff options
author | Rasmus Dahlberg <rasmus@rgdd.se> | 2024-05-04 15:37:28 +0200 |
---|---|---|
committer | Rasmus Dahlberg <rasmus@rgdd.se> | 2024-05-04 16:26:35 +0200 |
commit | b80d645af02e8153b8b12013bf1a68770453d72e (patch) | |
tree | a2fadc471eb3d1bbfbbc178957a833919e775419 /README.md | |
parent | 14d87322a88ce5d54097cd29db428d060137bcf1 (diff) |
Update documentation to indicate this is a fork
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 56 |
1 files changed, 19 insertions, 37 deletions
@@ -1,50 +1,32 @@ # Researcher A simple monospaced resume theme for Hugo. It was ported from Jekyll theme -[ankitsultana/researcher](https://github.com/ankitsultana/researcher). - -## Screenshot -![screenshot](https://user-images.githubusercontent.com/23409060/188607083-dd087121-16f9-4706-b8b9-a0e4c9e35d93.png) +[ankitsultana/researcher](https://github.com/ankitsultana/researcher) in +[ojroques/hugo-researcher](https://github.com/ojroques/hugo-researcher). This +repository contains a fork tailored specifically for https://www.rgdd.se. ## 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 -``` + + git submodule add git@git.rgdd.se:www-theme themes/www-theme Update the theme option in `config.toml`: -```toml -theme = "researcher" -``` + + theme = "www-theme" + +## Development + +Development branches can be installed with `git submodule add -b BRANCH`. + +To try changes locally using the example site, run: + + hugo server -s exampleSite --themesDir=../../ ## 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. + +See [exampleSite/config.toml](./exampleSite/config.toml) for an example. ## License -[GPL-3.0 License](https://github.com/ojroques/hugo-researcher/blob/master/LICENSE) + +[GPL-3.0 License](./LICENSE) |