This is a premium theme for HUGO, inspired by the Lingonberry WordPress theme from Anders Norén.
Bilberry is an adaption that comes with different optimizations and little features as listed below.
Click here for a DEMO / PREVIEW.
If you like this theme and/or use it for commercial purposes, please support me!
- Quick Start
- Configuration
- Features
- Custom Post Types
- Custom colors and fonts
- Credits
- License
- Support Me and This Theme
- Create a new hugo site
hugo new site my-new-blog
- Install this theme
cd my-new-blog/themes
git clone https://github.com/Lednerb/bilberry-hugo-theme.git
If you don't use git, you can download and extract this theme manually into the themes folder.
Please ensure that the folder is renamed to "bilberry-hugo-theme"
- Copy example content and default config file for a quick start
cp -r bilberry-hugo-theme/exampleSite/* ../
- Test and configure your site
cd ../
hugo server -D
To configure your site according to your needs, just open the config.toml
file in your project folder and adjust the settings.
All options you can and should customize are commented so it should be no problem for you to get it done.
Bilberry includes a convenient search functionality for your site. You can test it on the demo site. Just click on the navigation bar at the top right of the header.
If you do not want to use the search functionality set algolia_search = false
in your config.toml
file.
If you want to include the algolia search for your site, you have to follow these steps:
- Register for a free Algolia Search account at https://www.algolia.com/
- Add a
New Application
. You can choose theCOMMUNITY
plan. - Switch over to
Indices
and create a new one. - Switch over to
API Keys
and copy yourApplication ID
,Search-Only API Key
and chosenIndex name
to yourconfig.toml
file. - Ensure that
algolia_search = true
is set.
You have to repeat this step every time you change a post or publish a new one to update the search index.
- Publish your changes via the
hugo
command. - Head over to
http://your-site.com/index.json
and copy everything in there - Login to your algolia account, open your index and click at
Add records manually
- Paste the copied text from the
index.json
file. - Done.
If you want to start a search on your blog simply type s
and the search menu will open.
To close it again you can enter esc
at any time.
Bilberry comes with a bunch of predefined post types.
Available post types are article
, audio
, code
, gallery
, link
, page
, quote
and video
.
To use a post type, just create new content via the hugo command.
For example:
hugo new quote/edward-snowden-about-privacy.md
article
is the default post type if you want to use another type of content as the predefined.
Just discover the entries from the exampleSite
folder to get an overview of the great possibilities Bilberry provides ;-)
The post type page
is the only one that appears in the top navigation (when you click on the navigation button on the top right).
A page
can be a static page (about me or impress site) or a link to another page as it is used in the demo to link to the Bilberry GitHub repository.
The post type link
always links to an external site and can be used with or without a background image.
You can influence the summary outpot on the listing pages (such as the home page or the category or tag pages) in three ways:
-
You don't set a manual summary break.
Hugo will care for you and generates a summary as well as a Continue reading link. -
You set a manual break via
<!--more-->
Just write your content and if you want to break use the code snippet to tell Hugo to break here. -
You want to display the full article without a Continue reading link
In this case, set the optionnoSummary: true
in the header area (Front Matter) of your.md
file.
If you want to enable the functionality for your users to write comments below your articles, you can register for a free Disqus account.
Just create a new site and copy your site's short name to the config.toml
file at disqusShortname
.
You can manage and moderate the comments either on your website or at the disqus management panel.
Bilberry is optimized for desktop and mobile devices (tablets and smartphones).
If you want to permanently display the top navigation with the algolia search bar and the page
entries, you can set the permanentTopNav
option to true
in your site's config file.
Note that on mobile devices the navigation will still be collapsed because otherwise, the navigation menu hides the essential parts of your site.
If you want to add MathJAX markup support, set parameter enable_mathjax
option to true
in our site's config file.
If you want to add a custom post type to change the icon in the bubble on the left column you can simply create those as you wish.
If you want to create a book
post type, for example, you can do the following:
-
Copy the default
themes/bilberry-hugo-theme/layouts/partials/content-type/article.html
to your site'slayouts/partials/content-type/
folder. -
Rename the file to your custom post type. A proper name in the book scenario would be
book.html
-
Customize the file.
You can change the icon in the bubble with another Font Awesome Icon.
In the book scenario we would change thefa-pencil
class tofa-book
:<i class="fa fa-fw fa-book"></i>
-
Create your new posts with the post type prefix:
hugo new book/a-very-cool-book.md
-
Done.
If you want to use custom Front Matter variables, create a book.md
archetype in your archetypes/
directory.
You can find further information in the official HUGO docs.
If you want to change the default post types (e.g., don't use the pencil icon on the article
or default type, but another one) copy the original file to your local layouts/partials/content-type/
directory and edit it there.
Otherwise, your changes would be overwritten when you update to the latest theme version.
Bilberry uses SCSS for styling and a Webpack-based workflow to dynamically create the combined and compresses production-ready stylesheets.
If you want to change any colors or fonts, you have follow these steps:
- Install this theme to your
themes
directory - Install yarn
cd themes/bilberry-hugo-theme/src
- Run
yarn install
to install all necessary dependencies - Modify the
scss/_variables.scss
file to customize your colors.
If you want to change the header's color just edit the$base-color
variable - After finishing your changes, run
yarn run production
to produce your customized stylesheets - Done
If you 're going to change the default fonts (e.g., lack of support for Cyrillic languages), you can use some of the Google Fonts.
Select your favorite fonts and copy the @import url('...');
directive to the src/css/fonts.css
file.
Now you have to modify the scss/_variables.scss
and set the $headline-font
and $content-font
to the selected ones.
Follow the steps 1-7 to implement your custom font to your site.
Note: You don't have to upload the node_modules
folder to your webspace, this is only created and needed to generate your customized stylesheets.
Bilberry is inspired by the WordPress theme Lingonberry, created by Anders Norén.
Bilberry is a theme for the great HUGO static site generator.
A big thank you goes to @Ipstenu for his help in this thread that helped me to create the index.json
for the algolia export.
The Bilberry Theme for HUGO is licensed under the MIT license.
If you enjoy this theme (and especially if you make money with your blog) and want to use it for your site, please consider a small or generous monthly support towards me so I can keep up supporting and maintaining this theme in the future.
You don’t want to use Patreon?
Just write me a short mail and we’ll find a solution: [email protected]