diff options
| -rw-r--r-- | README.md | 56 | ||||
| -rw-r--r-- | exampleSite/.gitignore | 3 | ||||
| -rw-r--r-- | exampleSite/config.toml | 2 | ||||
| -rw-r--r-- | theme.toml | 17 |
4 files changed, 31 insertions, 47 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 - +[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) diff --git a/exampleSite/.gitignore b/exampleSite/.gitignore new file mode 100644 index 0000000..6667702 --- /dev/null +++ b/exampleSite/.gitignore @@ -0,0 +1,3 @@ +.hugo_build.lock +public +resources/_gen/assets/sass/ diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 438f23b..a04b5f2 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,6 +1,6 @@ title = "Researcher" baseURL = "https://example.com" -theme = "researcher" +theme = "www-theme" disableKinds = ["taxonomy", "term"] enableEmoji = true math = false # enable KaTeX (https://katex.org/) globally @@ -1,17 +1,16 @@ -name = "Researcher" +name = "www-theme" license = "GPL-3.0" -licenselink = "https://github.com/ojroques/hugo-researcher/blob/master/LICENSE" -description = "A simple monospaced resume theme for Hugo." +licenselink = "https://git.rgdd.se/www-theme/tree/LICENSE" +description = "A simple monospaced landing-page theme for Hugo." tags = ["blog", "bootstrap", "clean", "minimal", "personal", "responsive", "resume", "simple"] features = ["bootstrap", "responsive", "simple"] -homepage = "https://github.com/ojroques/hugo-researcher" +homepage = "https://git.rgdd.se/www-theme" min_version = "0.74.3" [author] - name = "Olivier Roques" - homepage = "https://oroques.dev/" + name = "Rasmus Dahlberg" + homepage = "https://www.rgdd.se/" [original] - author = "Ankit Sultana" - homepage = "https://github.com/ankitsultana" - repo = "https://github.com/ankitsultana/researcher" + author = "Olivier Roques" + repo = "https://github.com/ojroques/hugo-researcher" |