hugo-theme-bootstrap4-blog/README.md

Hugo Bootstrap v4 Blog

A simple Hugo theme based on the Bootstrap v4 blog example. Still a work in progress.

See picturingjordan.com for an example of this theme in use.

Features

• Responsive design
• Uses Bootstrap v4's native system fonts to load quickly and look good on all platforms
• Basic OpenGraph and Twitter Card metadata support
• robots.txt linking to XML sitemap (disabled by default, see Hugo docs)
• Basic support for multi-lingual content (added in Hugo 0.17)
• Support Google, Bing, and Yandex site verification via meta tags
• Support Google Analytics (async version), see Hugo docs

Usage

Clone the repository to your site's themes directory. Refer to exampleSite/config.toml for optional configuration values.

Building (For Developers)

This theme uses the Bootstrap framework. A static version of this is already included, but if you want to bump the version, tweak the style, etc, you'll need to rebuild the assets. Make sure you have NodeJS v4 or v6 installed, and then run the following from inside the theme's directory:

$ npm install
$ npm run build

TODO

• add optional social links to sidebar
• add favicon (user can place one in static dir, but theme could handle this better for modern devices)
• add author page (for when you click author name in a post/summary) #2
• add images to sitemap? https://gohugo.io/templates/sitemap/
• add support for Disqus (I don't use it!)
• test multilingual stuff like menus, probably need more absURL/relURL fixes (see Hugo docs)
• make sidebar optional (works, but need to adjust CSS to make main content responsive)

License

This repository contains the code of Bootstrap, which is licensed under the MIT license, and Font Awesome, which uses various licenses.

Otherwise, the contents are GPLv3.