Giters

Pizzacus / bilberry-hugo-theme

Premium theme for the hugo site builder. DEMO:

Home Page:https://lednerb.github.io/bilberry-hugo-theme/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bilberry Hugo Theme

All Contributors GitHub version License Discord GitHub stars

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!

Table of Contents

Requirements

Hugo version >= 0.53 required

Quick Start

  • Create a new hugo site
hugo new site my-new-blog
  • Install the latest version of 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 this theme HERE and extract it 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/* ../
  • Remove the default archetype
cd ../
rm archetypes/default.md
  • Test and configure your site
hugo server -D

Important:
Do NOT change the name of the theme folder.
If you rename the folder the different post types will not work.

Configuration

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.

Features

Algolia Search

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.

Setup

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:

  1. Register for a free Algolia Search account at https://www.algolia.com/
  2. Add a New Application. You can choose the COMMUNITY plan.
  3. Switch over to Indices and create a new one.
  4. Switch over to API Keys and copy your Application ID, Search-Only API Key and chosen Index name to your config.toml file.
  5. Ensure that algolia_search = true is set.
  6. Check the next section Update the search index, follow the steps and come back again
  7. Back in your algolia index, switch to DISPLAY and select language in the Attributes for faceting option.
  8. Done.

Update the search index

You have to repeat this step every time you change a post or publish a new one to update the search index.

  1. Publish your changes via the hugo command.
  2. Head over to the public/index.json file and copy everything in there
  3. Login to your algolia account, open your index and click at Add records manually
  4. Paste the copied text from the index.json file.
  5. Done.

Keyboard Shortcuts

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.

Post Types

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 ;-)

Pages and External Links

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.

Reposting an Article / Duplicated Content [SEO]

If you want to repost an article from another website or have duplicated content on your own site, for SEO reasons it's a good practice to link to the original / canonical URL.

If you want to mark one of your content sites as duplicated content you can simply use the following front matter configuration option:

original_url: "https://example.org/path/to/content"

Further Information:

Summary Breaks

You can influence the summary output on the listing pages (such as the home page or the category or tag pages) in different 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 option noSummary: true in the header area (Front Matter) of your .md file.

  • You can define a summary that differs from the first content lines
    Use the summary: "Here goes my summary" Front Matter variable.
    In this case no Continue reading link will be displayed.

Disqus comments

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.

Responsive Design

Bilberry is optimized for desktop and mobile devices (tablets and smartphones).

Automatic Image Resizing

The bilberry theme handles image crops and resizes automatically by default. However, if you want to disable this functionality in general, you can set resizeImages: false in your config.toml file.

If you want to disable this functionality just on some posts, you can set resizeImages: false in your post's settings.

Permanent Top Navigation

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.

MathJAX Markup

If you want to add MathJAX markup support, set parameter enable_mathjax option to true in your site's config file.

Favicons

Using favicons nowadays is not a trivial thing. There are many different sizes and file types for the various mobile and desktop browsers and for the shortcuts for Android and iOS devices.

This theme makes it easy for you to include all needed files:

  1. Visit https://realfavicongenerator.net/ and generate your favicon according to your needs
  2. Copy & Paste the generated files into your /static folder
  3. Edit the /layouts/partials/favicon.html file and copy & paste the HTML code from the generated instruction

Important: You have to follow the Quick Start guideline or manually copy the /layouts/partials/favicon.html file from the theme to your site's /layouts directory. Otherwise the file is missing.

Custom 404 site

If you want to customize your 404 site, copy the themes/bilberry-hugo-theme/layouts/404.html to your local layouts/404.html and edit the file.

You can quickly change the message and / or the icon class for example. Otherwise, you can replace the whole content with your 404 site markup.

Custom Post Types

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:

  1. Copy the default themes/bilberry-hugo-theme/layouts/partials/content-type/article.html to your site's layouts/partials/content-type/ folder.

  2. Rename the file to your custom post type. A proper name in the book scenario would be book.html

  3. Customize the file.
    You can change the icon in the bubble with another Font Awesome Icon.
    In the book scenario we would change the fa-pencil class to fa-book: <i class="fas fa-fw fa-book"></i>

  4. Create your new posts with the post type prefix: hugo new book/a-very-cool-book.md

  5. 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.

External Images

If you want to use external images (on another server or installation, etc.) for the featuredImage or in the gallery post type, you can use them by specifying the following in the post's config within the frontmatter:

/content/article/my-external-featured-image-post.md

featuredImage: "https://example.org/images/my-image.jpg"

/content/gallery/my-external-gallery-post.md

gallery: [
    "https://example.org/images/gallery-image1.jpg",
    "https://example.org/images/gallery-image2.jpg",
    "https://example.org/images/gallery-image3.jpg"
]

Customizing Individual Posts

Posts can be customized via a variety of options.

To exclude posts from appearing on your blog index, while still being displayed in categories, add excludeFromIndex: true to the post configuration.

The theme also has options for a pinned post. Just uncomment pinnedPost in config.toml, and point it to the post you'd like permanently pinned to the top of the page. The pinOnlyToFirstPage setting lets you control if you'd like to only display the pinned post on the index, or on all pages.

A custom icon can be declared per post, by specifying a font-awesome icon in the post configuration, such as icon: fa-thumb-tack for a pinned post.

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.

Custom colors and fonts

Bilberry uses SCSS for styling and NPM with Laravel Mix for dependancy management.

If you want to change any colors or fonts, you have follow these steps:

  1. Install this theme to your themes directory
  2. cd themes/bilberry-hugo-theme
  3. npm install
  4. 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
  5. use npm run dev for development and preview purposes and npm run production when you finished the changes

CSS and JS modules

This theme supports hot-swappable CSS and JavaScript extentions. Modules can be specified using the (css|js)_modules list parameter. Modules can be specified either relative to the static directory (e.g. exampleSite/static/css/custom.css) or as a URL.

Modules are imported in the order they appear in the list, and immediately after the default Bilberry CSS and JS files are imported.

Adding a Cookie disclaimer

Depending on the type of website you are running with this theme you may also want to add a cookie consent information. The popuplar solution cookie consent can be integrated into the theme by loading the resources as external CSS and JS modules.

Use the configurator on the cookie consent website to generate the required initialization code and add it to a local static/init-cookieconsent.js file e.g.

// https://cookieconsent.insites.com/download/#
window.addEventListener('load', function () {
  window.cookieconsent.initialise({
    'palette': {
      'popup': {
        'background': '#cc0033'
      },
      'button': {
        'background': '#fff'
      }
    }
  })
})

Then you only need to modify your config.toml to load the local init script and the libraries. You can either download the files and put them in your /static directory as well or reference them directly using a CDN. Serving the files with your website reduces external dependencies, increases privacy and makes sure your website can be developed in an offline environment as well.

css_modules = ["..", "//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.css"]
js_modules = ["..", "//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.1.0/cookieconsent.min.js", "init-cookieconsent.js"]

Translations

This theme has support for multi-language sites and therefore translations for 10+ languages. If you want to contribute and improve this theme for all users, please check our translation project at POEditor

Feel free to submit a request for a new language or improve existing ones!

Credits

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.

Support and Discussions

If you enjoy this theme and want to stay up to date or just want to say thanks, have a look at this Discord Channel:

Discord

Contributors

Thanks goes to these wonderful people (emoji key):


Sascha Brendel
πŸ’¬ πŸ“ πŸ’» 🎨 πŸ“– 🌍
Anna Brendel
πŸ€” 🌍
Givi Khojanashvili
πŸ’»
Chung Tran Anh
πŸ’» 🌍
Minke Zhang
πŸ’»

Pavel Kanyshev
πŸ’» 🌍
Marcel Kraus
πŸ’»
Nick Busey
πŸ’»
lkorzen
🌍
Chris Stayte
πŸ›

Dmitry Matrosov
πŸ’»
Marc-Antoine
πŸ’» πŸ›
Nina Zakharenko
πŸ’» πŸ› πŸ“–
Nisarga
πŸ’»
Pablo Domingo Rojo
πŸ’»

Rob Baruch
πŸ’»
Taoshi
🌍
nonumeros
πŸ’»
Marcelo Gonçalves
🌍
DΓ‘vid SΓ‘rkΓ‘ny
🌍

meonamz
🌍
Hamza Yusuf Γ‡akΔ±r
🌍

This project follows the all-contributors specification. Contributions of any kind welcome!

License

The Bilberry Theme for HUGO is licensed under the MIT license.

About

Premium theme for the hugo site builder. DEMO:

https://lednerb.github.io/bilberry-hugo-theme/

License:MIT License

Languages

Language:CSS 50.6%Language:HTML 40.5%Language:JavaScript 8.9%