Compare commits

..

19 Commits

Author SHA1 Message Date
Nuno Coração 2c15da1273 Update package.json 2022-10-28 19:07:40 +01:00
Nuno Coração e76cbb53ae added showMenu to configs to highlight feature 2022-10-28 18:39:36 +01:00
Nuno Coração 5a734c1a51 Merge pull request #129 from madoke/main
Optionally disable footer menu. Enabled by default
2022-10-28 18:36:18 +01:00
Nuno Coração 54a99f72e0 Update config/_default/params.toml
Co-authored-by: David Simão <madoke@users.noreply.github.com>
2022-10-28 18:34:39 +01:00
Nuno Coração a366cab831 Merge branch 'main' into main 2022-10-28 18:34:13 +01:00
Nuno Coração 2c15750c9e Merge pull request #166 from nunocoracao/163-option-to-enabledisable-medium-zoom-image-in-paramstoml
added disableImageZoom parameter to disable image zoom
2022-10-28 18:32:14 +01:00
Nuno Coração 243267d281 added disableImageZoom parameter to disable image zoom 2022-10-28 18:31:56 +01:00
Nuno Coração 828f5cda23 Merge pull request #165 from nunocoracao/164-background-hero-layout-aligns-long-titles-to-the-left-on-mobile
fixed background/hero homepage layouts not centering on mobile
2022-10-28 18:03:01 +01:00
Nuno Coração c26bae0cb7 fixed background/hero homepage layouts not centering on mobile 2022-10-28 18:02:37 +01:00
Nuno Coração e354929549 updated version 2022-10-25 23:47:57 +01:00
Nuno Coração 3d7ac720ee Merge pull request #158 from nunocoracao/157-links-rendering-with-extra-white-space
removed extra whitespace from links
2022-10-25 23:47:23 +01:00
Nuno Coração 89ab364735 removed extra whitespace from links 2022-10-25 23:46:52 +01:00
Nuno Coração 9cb99c0ec7 added katex shortcode example 2022-10-25 19:55:53 +01:00
madoke c049cec8df fix typo/markdown 2022-10-24 21:56:16 +01:00
madoke 4a8c23c9d5 showMenu defaults to enabled 2022-10-24 21:54:37 +01:00
madoke 2211ce50be Adds documentation to showMenu parameter 2022-10-24 21:54:22 +01:00
Nuno Coração 4517ae0f0f Update index.md 2022-10-24 14:00:36 +01:00
Nuno Coração 27098fab5f Update README.md 2022-10-23 22:31:50 +01:00
madoke 11120610fd Optionally disable footer menu. Enabled by default 2022-10-16 21:28:27 +01:00
11 changed files with 32 additions and 25 deletions
+1 -4
View File
@@ -57,7 +57,7 @@ Detailed instructions for each method can be found in the [Installation](https:/
### Quick start using git submodules ### Quick start using git submodules
> **Note:** Ensure you have **git**, **Go**, and **Hugo** installed, and that you have created a new Hugo project before proceeding. > **Note:** Ensure you have **Git**, **Go**, and **Hugo** installed, and that you have created a new Hugo project before proceeding.
1. From your project directory, initialise git: 1. From your project directory, initialise git:
@@ -73,11 +73,8 @@ Detailed instructions for each method can be found in the [Installation](https:/
3. In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder. 3. In the root folder of your website, delete the `config.toml` file that was generated by Hugo. Copy the `*.toml` config files from the theme into your `config/_default/` folder.
> **Note:** Do not overwrite the `module.toml` file you created above!
You will find these theme config files in the Hugo cache directory, or [download a copy](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/nunocoracao/blowfish/tree/main/config/_default) from GitHub. You will find these theme config files in the Hugo cache directory, or [download a copy](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/nunocoracao/blowfish/tree/main/config/_default) from GitHub.
4. Follow the [Getting Started](https://nunocoracao.github.io/blowfish/docs/getting-started/) instructions to configure your website. 4. Follow the [Getting Started](https://nunocoracao.github.io/blowfish/docs/getting-started/) instructions to configure your website.
### Quick start using Hugo ### Quick start using Hugo
+1
View File
@@ -16,6 +16,7 @@ enableCodeCopy = true
# robots = "" # robots = ""
[footer] [footer]
# showMenu = true
showCopyright = true showCopyright = true
showThemeAttribution = true showThemeAttribution = true
showAppearanceSwitcher = true showAppearanceSwitcher = true
+1
View File
@@ -16,6 +16,7 @@ mainSections = ["docs"]
# robots = "" # robots = ""
[footer] [footer]
showMenu = true
showCopyright = true showCopyright = true
showThemeAttribution = true showThemeAttribution = true
showAppearanceSwitcher = true showAppearanceSwitcher = true
@@ -133,6 +133,8 @@ Many of the article defaults here can be overridden on a per article basis by sp
|`logo`|_Not set_|The relative path to the site logo file within the `assets/` folder. The logo file should be provided at 2x resolution and supports any image dimensions.| |`logo`|_Not set_|The relative path to the site logo file within the `assets/` folder. The logo file should be provided at 2x resolution and supports any image dimensions.|
|`mainSections`|_Not set_|The sections that should be displayed in the recent articles list. If not provided the section with the greatest number of articles is used.| |`mainSections`|_Not set_|The sections that should be displayed in the recent articles list. If not provided the section with the greatest number of articles is used.|
|`robots`|_Not set_|String that indicates how robots should handle your site. If set, it will be output in the page head. Refer to [Google's docs](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives) for valid values.| |`robots`|_Not set_|String that indicates how robots should handle your site. If set, it will be output in the page head. Refer to [Google's docs](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives) for valid values.|
|`disableImageZoom`|`false`|Disables image zoom feature across all the images in the site.|
|`footer.showMenu`|`true`|Show/hide the footer menu, which can be configured in the `[[footer]]` section of the `config/_default/menus.en.toml` file.|
|`footer.showCopyright`|`true`|Whether or not to show the copyright string in the site footer. Note that the string itself can be customised using the `copyright` parameter in the [languages configuration](#language-and-i18n).| |`footer.showCopyright`|`true`|Whether or not to show the copyright string in the site footer. Note that the string itself can be customised using the `copyright` parameter in the [languages configuration](#language-and-i18n).|
|`footer.showThemeAttribution`|`true`|Whether or not to show the "powered by" theme attribution in the site footer. If you choose to disable this message, please consider attributing the theme somewhere else on your site (for example, on your about page).| |`footer.showThemeAttribution`|`true`|Whether or not to show the "powered by" theme attribution in the site footer. If you choose to disable this message, please consider attributing the theme somewhere else on your site (for example, on your about page).|
|`footer.showAppearanceSwitcher`|`false`|Whether or not to show the appearance switcher in the site footer. The browser's local storage is used to persist the visitor's preference.| |`footer.showAppearanceSwitcher`|`false`|Whether or not to show the appearance switcher in the site footer. The browser's local storage is used to persist the visitor's preference.|
@@ -192,4 +194,4 @@ Many of the article defaults here can be overridden on a per article basis by sp
The theme also includes a `markup.toml` configuration file. This file contains some important parameters that ensure that Hugo is correctly configured to generate sites built with Blowfish. The theme also includes a `markup.toml` configuration file. This file contains some important parameters that ensure that Hugo is correctly configured to generate sites built with Blowfish.
Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to fucntion incorrectly and could result in unintended behaviour. Always ensure this file is present in the config directory and that the required values are set. Failure to do so may cause certain features to function incorrectly and could result in unintended behaviour.
@@ -11,9 +11,12 @@ KaTeX can be used to render mathematical notation within articles.
{{< katex >}} {{< katex >}}
Blowfish will only bundle the KaTeX assets into your project if you make use of mathematical notation. In order for this to work, simply include the [`katex` shortcode]({{< ref "docs/shortcodes#katex" >}}) within the article. Any KaTeX syntax on that page will then be automatically rendered. Blowfish will only bundle the KaTeX assets into your project if you make use of mathematical notation. In order for this to work, simply include the [`katex` shortcode]({{< ref "docs/shortcodes#katex" >}}) within the article. Example below:
Use the online reference of [supported TeX functions](https://katex.org/docs/supported.html) for the available syntax. ```md
{{</* katex */>}}
```
Any KaTeX syntax on that page will then be automatically rendered. Use the online reference of [supported TeX functions](https://katex.org/docs/supported.html) for the available syntax.
## Inline notation ## Inline notation
+1 -2
View File
@@ -1,3 +1,2 @@
<a href="{{ .Destination | safeURL }}" {{ with .Title}} title="{{ . }}"{{ end }} {{ if or (strings.HasPrefix .Destination "http:") (strings.HasPrefix .Destination "https:") }} target="_blank"{{ end }}> <a href="{{ .Destination | safeURL }}" {{ with .Title}} title="{{ . }}"{{ end }} {{ if or (strings.HasPrefix .Destination "http:") (strings.HasPrefix .Destination "https:") }} target="_blank"{{ end }}>
{{ .Text | safeHTML }} {{ .Text | safeHTML }}</a>
</a>
+15 -11
View File
@@ -1,16 +1,18 @@
<footer class="py-10 print:hidden"> <footer class="py-10 print:hidden">
{{/* Footer menu */}} {{/* Footer menu */}}
{{ if .Site.Menus.footer }} {{ if .Site.Params.footer.showMenu | default true }}
<nav class="pb-4 text-base font-medium text-neutral-500 dark:text-neutral-400"> {{ if .Site.Menus.footer }}
<ul class="flex flex-col list-none sm:flex-row"> <nav class="pb-4 text-base font-medium text-neutral-500 dark:text-neutral-400">
{{ range .Site.Menus.footer }} <ul class="flex flex-col list-none sm:flex-row">
<li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0"> {{ range .Site.Menus.footer }}
<a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href="{{ .URL }}" <li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0">
title="{{ .Title }}">{{ .Name | markdownify | emojify }}</a> <a class="decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href="{{ .URL }}"
</li> title="{{ .Title }}">{{ .Name | markdownify | emojify }}</a>
{{ end }} </li>
</ul> {{ end }}
</nav> </ul>
</nav>
{{ end }}
{{ end }} {{ end }}
<div class="flex items-center justify-between"> <div class="flex items-center justify-between">
@@ -41,11 +43,13 @@
</div> </div>
<script> <script>
{{ if not .Site.Params.disableImageZoom | default true }}
mediumZoom(document.querySelectorAll("img:not(.nozoom)"), { mediumZoom(document.querySelectorAll("img:not(.nozoom)"), {
margin: 24, margin: 24,
background: 'rgba(0,0,0,0.5)', background: 'rgba(0,0,0,0.5)',
scrollOffset: 0, scrollOffset: 0,
}) })
{{ end }}
</script> </script>
{{ $jsProcess := resources.Get "js/process.js" }} {{ $jsProcess := resources.Get "js/process.js" }}
{{ $jsProcess = $jsProcess | resources.Minify | resources.Fingerprint "sha512" }} {{ $jsProcess = $jsProcess | resources.Minify | resources.Fingerprint "sha512" }}
+1 -1
View File
@@ -17,7 +17,7 @@
{{ end }} {{ end }}
{{ end }} {{ end }}
</div> </div>
<div class="relative px-4 py-16 sm:px-6 sm:py-24 lg:py-32 lg:px-8 flex flex-col items-center"> <div class="relative px-4 py-16 sm:px-6 sm:py-24 lg:py-32 lg:px-8 flex flex-col items-center justify-center text-center">
{{ with .Site.Author.image }} {{ with .Site.Author.image }}
{{ $authorImage := resources.Get . }} {{ $authorImage := resources.Get . }}
{{ if $authorImage }} {{ if $authorImage }}
+1 -1
View File
@@ -14,7 +14,7 @@
{{ end }} {{ end }}
{{ end }} {{ end }}
</div> </div>
<div class="relative px-4 py-16 sm:px-6 sm:py-24 lg:py-32 lg:px-8 flex flex-col items-center"> <div class="relative px-4 py-16 sm:px-6 sm:py-24 lg:py-32 lg:px-8 flex flex-col items-center justify-center text-center">
{{ with .Site.Author.image }} {{ with .Site.Author.image }}
{{ $authorImage := resources.Get . }} {{ $authorImage := resources.Get . }}
{{ if $authorImage }} {{ if $authorImage }}
+2 -2
View File
@@ -1,12 +1,12 @@
{ {
"name": "hugo-blowfish-theme", "name": "hugo-blowfish-theme",
"version": "2.3.1", "version": "2.4.5",
"lockfileVersion": 2, "lockfileVersion": 2,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "hugo-blowfish-theme", "name": "hugo-blowfish-theme",
"version": "2.3.1", "version": "2.4.5",
"hasInstallScript": true, "hasInstallScript": true,
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "hugo-blowfish-theme", "name": "hugo-blowfish-theme",
"version": "2.4.4", "version": "2.5.0",
"description": "Blowfish theme for Hugo", "description": "Blowfish theme for Hugo",
"scripts": { "scripts": {
"preinstall": "rimraf assets/vendor", "preinstall": "rimraf assets/vendor",