From 07b3a14103db1692ab5c5806d71681c707e8d752 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Sun, 12 Nov 2023 16:37:52 +0000 Subject: [PATCH] Theme Files Update --- README.md | 115 ++++++++++++++--------------------- layouts/_default/single.html | 2 +- layouts/posts/single.html | 4 +- 3 files changed, 47 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 40512f1..8d58ea7 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ -# Hugo theme Hermit - V2 +# hermit-V2 -: The Minimal Hugo Theme -Initially, when I started my Blog journey, I was enthralled by this very theme and I am using it since. However, original developer has ceased maintaining the theme and it is riddled with many bugs. Hence, I have taken upon myself to maintain this theme. +> OG : [Hermit Theme](https://github.com/Track3/hermit) by [Track3](https://github.com/Track3) -I fully intend to keep the essence of the theme as-it-is and only add minor updates and squash bugs which may arise. +Hermit-V2 is a minimal and fast theme for Hugo, built for bloggers who want a simple and focused website. This is a maintained fork of [Hermit](https://github.com/Track3/hermit), which iterates over the original work to have a almost-stable experience with ug fixes and new features. -> Let's make __Hermit__ great again +![](https://github.com/1bl4z3r/hermit-V2/blob/main/images/screenshot.png) -DEMO : [Hermit-V2](https://1bl4z3r.github.io/hermit-V2/) +### History -GoHugo Theme Page : [https://themes.gohugo.io/themes/hermit-v2/](https://themes.gohugo.io/themes/hermit-v2/) +When I had switched from jekyll to Hugo, I was in a need of a theme. I was enthralled by this very theme and I am using it since in my own personal blog. However, it looks like [OP]((https://github.com/Track3)) has stopped maintaining this theme and as a result, it is riddled with bugs and code breaks. Hence, I have taken upon myself to maintain this theme. Intention of this project is to keep the essence of the theme as-it-is and only add minor updates and squash bugs which may arise. -### Installation +> GoHugo Theme Page : [https://themes.gohugo.io/themes/hermit-v2/](https://themes.gohugo.io/themes/hermit-v2/) + +## Demo + +Demo page [https://1bl4z3r.github.io/hermit-V2](https://1bl4z3r.github.io/hermit-V2), which is both demo as well as documentation for the theme, is located in [Staging Branch](https://github.com/1bl4z3r/hermit-V2/tree/staging) + +## Configuration Guide + +Configuration Guide is present in [Explaining Configs](https://1bl4z3r.github.io/hermit-V2/en/posts/explaining-configs/) + +## Installation Run this command from the root of your Hugo directory: @@ -24,6 +34,24 @@ Or, if your Hugo site is already in git, you can include this repository as a [g git submodule add https://github.com/1bl4z3r/hermit-V2 themes/hermit-v2 ``` +## GOOD-TO-KNOW LIST + +### Features Inherited from Original Theme + +* A single-column layout and carefully crafted typography offers a great reading experience. +* Navigations and functions are placed in the bottom bar which will hide when you scroll down. +* Featured image is supported. It will be displayed as a dimmed background of the page. +* Displays all of your posts on a single page, with one section per year, simple and compact. +* Extremely lightweight and load fast. No third party framework, no unnecessary code. +* All code fields feature syntax highlighting and a code-copy function +* Responsive & Retina Ready. Scales gracefully from a big screen all the way down to the smallest mobile phone. Assets in vector format ensures that it looks sharp on high-resolution screens. + +![](https://github.com/1bl4z3r/hermit-V2/blob/main/images/hermit.png) + +### Configuration + +Site Configuration is done through `hugo.toml` or `hugo.yaml` file in root directory of your Hugo Site. To aid you, there is a [hugo.toml.example](https://github.com/1bl4z3r/hermit-V2/blob/main/hugo.toml.example) file located in theme folder. See this configuration in action [here](https://github.com/1bl4z3r/hermit-V2/blob/staging/hugo.toml). See what each configuration does [here](https://1bl4z3r.github.io/hermit-V2/en/posts/explaining-configs/#configuation-in-hugotoml). + ### Custom CSS and JS I have found that there are some requirement where custom CSS and JS should be supplied to a page to make it work. This custom files are not required for whole of the site, but is restricted to a page or few particular pages. E.g. If you make contact form. @@ -37,59 +65,7 @@ custom_js = ["js/custom-about.js"] The files itself will reside in `static/css` for CSS files and `static/js` for JS files. Refer to [Staging Branch](https://github.com/1bl4z3r/hermit-V2/tree/staging) to have a feel on how [this](https://github.com/1bl4z3r/hermit-V2/blob/staging/content/about-hugo.md) is implemented. -### Demo - -Demo page [https://1bl4z3r.github.io/hermit-V2/](https://1bl4z3r.github.io/hermit-V2/), which is both demo as well as documentation for the theme, is located in [Staging Branch](https://github.com/1bl4z3r/hermit-V2/tree/staging) - -### Configuration Guide - -Configuration Guide is present in [Explaining Configs](https://1bl4z3r.github.io/hermit-V2/en/posts/explaining-configs/) - ---- - -# Original README - -Hermit is a minimal and fast theme for Hugo. It's built for bloggers who want a simple and focused website. - -![](https://github.com/1bl4z3r/hermit-V2/blob/main/images/screenshot.png) - -## Features - -* A single-column layout and carefully crafted typography offers a great reading experience. -* Navigations and functions are placed in the bottom bar which will hide when you scroll down. -* Featured image is supported. It will be displayed as a dimmed background of the page. -* Displays all of your posts on a single page, with one section per year, simple and compact. -* Extremely lightweight and load fast. No third party framework, no unnecessary code. -* All code fields feature syntax highlighting and a code-copy function -* Responsive & Retina Ready. Scales gracefully from a big screen all the way down to the smallest mobile phone. Assets in vector format ensures that it looks sharp on high-resolution screens. - -![](https://github.com/1bl4z3r/hermit-V2/blob/main/images/hermit.png) - -## Getting started - -### Installation - -Run this command from the root of your Hugo directory: - -```bash -$ git clone https://github.com/Track3/hermit.git themes/hermit -``` - -Or, if your Hugo site is already in git, you can include this repository as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). This makes it easier to update this theme. For this you need to run: - -```bash -$ git submodule add https://github.com/Track3/hermit.git themes/hermit -``` - -Alternatively, if you are not familiar with git, you can download the theme as a `.zip` file, unzip the theme contents, and then move the unzipped source into your `themes` directory. - -For more information, read the official [documentation](https://gohugo.io/themes/installing-and-using-themes/) of Hugo. - -### Configuration - -The example config file can be found in the theme's `exampleSite` folder. You can just copy the `config.toml` to the root directory of your Hugo site. There are instructions in the example config file, feel free to change strings as you like to customize your website. - -#### Favicon +### Favicon Use [RealFaviconGenerator](https://realfavicongenerator.net/) to generate these files, put them into your site's `static` folder: @@ -103,7 +79,7 @@ Use [RealFaviconGenerator](https://realfavicongenerator.net/) to generate these * safari-pinned-tab.svg * site.webmanifest -#### Social icons +### Social icons The following icons are supported, please make sure the `name` filed is exactly one of these: @@ -123,26 +99,24 @@ If that's not enough, you can see [Overriding templates](#overriding-templates) * Keep your regular pages in the `content` folder. To create a new page, run `hugo new page-title.md` * Keep your blog posts in the `content/posts` folder. To create a new post, run `hugo new posts/post-title.md` -### More customizations - -#### Overriding templates +### Overriding templates In Hugo, layouts can live in either the project’s (root) or the themes’ layout folders, any template inside the root layout folder will override theme's layout that relative to it, for example: `layouts/_default/baseof.html` will override `themes/hermit/layouts/_default/baseof.html`. So, you can easily customize the theme without edit it directly, which makes updating the theme easier. Here's some common customizations: -##### Customize social icons +### Customize social icons You can modify or add any svg icons in site's `layouts/partials/svg.html`. -##### Customize comment system +### Customize comment system We only have built-in support for Disqus at the moment, if that doesn't fit your needs, you can just add html to site's `layouts/partials/comments.html`. -##### Add custom analytics +### Add custom analytics If you prefer to use different analytics system other than google analytics, then add them inside `layouts/partials/analytics.html`. -#### Customize CSS +### Customize CSS If you'd like to customize theme color or fonts, you can simply override `assets/scss/_predefined.scss`, by simply copy it to site's root (keep the same relative path) then edit those variables. But keep in mind, you'll need **Hugo extended version** which has the ability to rebuild SCSS. You don't have to use extended version in production but in this case it's necessary to make sure the `resources` folder is committed and "up to date" (by running `hugo` or `hugo server` locally using the extended version). But anyway, always use the extended version if you can. -#### Code injection +### Code injection You can inject any html code to every page's document head or right above the closing body tag. This makes it easier to add any html meta data, custom css/js, dns-prefetch etc. To do this you simply need to create a file at site's `layouts/partials/extra-head.html` or `layouts/partials/extra-foot.html`, code inside will be injected to every page. @@ -152,5 +126,4 @@ You can inject any html code to every page's document head or right above the cl * [animate.css](https://daneden.github.io/animate.css/) - [MIT](https://github.com/daneden/animate.css/blob/master/LICENSE) * [feather](https://feathericons.com/) - [MIT](https://github.com/feathericons/feather/blob/master/LICENSE) * [code-copy.js](assets/js/code-copy.js) - [Tom Spencer](https://www.fiznool.com/blog/2018/09/14/adding-click-to-copy-buttons-to-a-hugo-powered-blog/) - -Thanks! +* [Everyone, who has submitted a PR](https://github.com/1bl4z3r/hermit-V2/pulls?q=is%3Apr+is%3Aclosed) \ No newline at end of file diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 8511109..9ba7177 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -19,7 +19,7 @@

{{ .Title }}

- {{ .Content | replaceRE "()" `${1}${3}` | safeHTML }} + {{ .Content | replaceRE "()" `${1}${3}` | safeHTML }}
{{- if .Params.comments }}
diff --git a/layouts/posts/single.html b/layouts/posts/single.html index 499832a..b2bef18 100644 --- a/layouts/posts/single.html +++ b/layouts/posts/single.html @@ -24,7 +24,7 @@

{{ .Title }}

- {{ .Content | replaceRE "()" `${1}${3}` | safeHTML }} + {{ .Content | replaceRE "()" `${1}${3}` | safeHTML }}
{{- if .Site.Params.relatedPosts }} {{- partial "related-posts.html" . -}} @@ -41,7 +41,7 @@
{{- partial "posts_single_info.html" . -}}
- {{ .Content | replaceRE "()" `${1}${3}` | safeHTML }} + {{ .Content | replaceRE "()" `${1}${3}` | safeHTML }}
{{- if .Site.Params.relatedPosts }} {{- partial "related-posts.html" . -}}