A Hugo theme wtih Github appearance.
Overview
Github Style Plus is a fork from the github-style theme with additional features added. This repository focuses on introducing the extra features. For basic usage information, please refer to the original repository.
Features
- Pinned posts and recent posts show together: In this version, both the pinned and recent posts blocks will be displayed together.
- Support reading time estimation: This feature evaluates the reading time of each post and displays the word count.
- Display your real GitHub followers stats: By enabling this feature and setting your GitHub account in the config.toml file, you can show your real GitHub followers count.
- Add sponsor link button: Customize the sponsor link in the config.toml file to display a sponsor button on the page.
- Keyword search locally: Enable local search using hugo rss to generate an index.xml feed file.
- Clickable day contributions: Make yearly-contributions graph clickable to show the posts added on specific days.
- Support custom CSS file: Create a style file in the static folder and set the file path in the config.toml file.
- Support previous and next post show more button: Hide most posts when the page first loads to improve page loading speed.
- Update old Google Analytics to GA4: Update the old Google Analytics code to GA4 as the old version is being retired.
- Support GTM Script: Add the GTM Script by adding the gtmId in the config.toml file.
- Custom organizations block: Set custom organizations for the theme in the config.toml file.
Installation
To install the Github Style Plus theme, follow these instructions:
- Initialize a Hugo site.
- Install the theme.
- Update the theme to the latest version (if it is not already installed).
- Rename the previous posts folder to post.
Summary
Github Style Plus is a fork of the github-style theme with added features such as displaying pinned and recent posts together, reading time estimation, real GitHub followers count, sponsor link button, local keyword search, clickable day contributions, support for custom CSS file, previous and next post show more button, updated Google Analytics, GTM Script support, and custom organizations block. Follow the installation guide to use this theme for your Hugo site.