hugo-theme-bootstrap4-blog/README.md

Hugo Bootstrap v4 Blog

A simple Hugo theme based on the Bootstrap v4 blog example.

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)
• Supports Google, Bing, and Yandex site verification via meta tags
• Supports Google Analytics (async version), see Hugo docs
• Supports Disqus comments, see Hugo docs
• Can show a message about cookie usage to the user, see exampleSite/config.toml

Usage

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

Content Suggestions

A few suggestions to help you get a good looking site quickly:

• Keep blog posts in the content/post directory, for example: content/post/my-first-post.md
• Keep static pages in the content directory, for example: content/about.md
• Keep media like images in the static directory, for example: static/2016/10/screenshot.png
• If you want an image to be shown when you share a post on social media, specify at least one image in the post's front matter, for example: images: ["/2016/10/screenshot.png"]
• Use the <!--more--> tag in posts to control how much of a post is shown on summary pages

See the source code and structure of picturingjordan.com to get more ideas.

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

Contributing

There are several ways to help with the development of the theme:

• Open an issue on GitHub if you have problems or feature requests
• Fork the repository on GitHub, add features on a "feature" branch like update-bootstrap, and then send a pull request with your changes

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/
• 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.