1
0
mirror of https://github.com/alanorth/hugo-theme-bootstrap4-blog.git synced 2024-11-13 07:57:02 +01:00
hugo-theme-bootstrap4-blog/README.md
Alan Orth 372a14e822
README.md: Use absolute path for screenshot link
Required for inclusion to Hugo's themes directory.
2016-10-17 22:11:11 -04:00

2.7 KiB

Hugo Bootstrap v4 Blog

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

Screenshot

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

Features

  • 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)
  • Displays categories and tags from front matter
  • Basic support for multi-lingual content (added in Hugo 0.17)
  • Configurable pagination for posts, categories, and tags pages
  • 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
  • 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)

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.