A blogging-centric Bootstrap v4 theme for the Hugo static site generator.
Go to file
Alan Orth 4d79004570
source/scss: Only import parts of font-awesome that we actually need
We can save ~30KiB in our stylesheet by only importing font-awesome
features and icons that we are actually using.
2016-11-16 12:00:21 +02:00
archetypes Add default archetype with some recommended options 2016-10-17 18:08:39 -04:00
exampleSite exampleSite/config.toml: Add parameter for cookie consent 2016-11-13 14:15:01 +02:00
i18n Added german translation for cookie consent. 2016-11-15 15:39:03 +01:00
images Add screenshot and thumbnail for Hugo themes directory 2016-10-17 22:18:39 -04:00
layouts Add plumbing for cookie consent 2016-11-13 14:13:17 +02:00
source/scss source/scss: Only import parts of font-awesome that we actually need 2016-11-16 12:00:21 +02:00
static static: Generate cookieconsent assets 2016-11-13 13:42:59 +02:00
.gitignore Revert ".gitignore: Add intermediate output from node-sass" 2016-09-26 10:08:53 +03:00
LICENSE.txt First commit with initial theme 2016-08-28 16:22:32 +03:00
README.md README.md: Remove TODO about author pages/indexes 2016-11-16 10:08:16 +02:00
package.json package.json: Add run script for cookieconsent 2016-11-13 13:42:22 +02:00
screenshot@2x.png Update screenshot 2016-09-26 09:06:21 +03:00
theme.toml theme.toml: Add link to original Bootstrap theme 2016-10-19 08:51:11 -07:00

README.md

Hugo Bootstrap v4 Blog

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

Screenshot

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

Features

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