alanorth
/
hugo-theme-bootstrap4-blog
mirror of https://github.com/alanorth/hugo-theme-bootstrap4-blog.git
1
0
Fork 0
Code Releases Activity
A blogging-centric Bootstrap v4 theme for the Hugo static site generator.
339 Commits 1 Branch 21 Tags 4.8 MiB
HTML 86%
SCSS 11.5%
JavaScript 2.5%
Go to file
Alan Orth 71e151ae60
images/tn.png: New thumbnail without browser 
Taken in Firefox Developer Tools...
 		2017-05-28 14:40:49 +03:00
archetypes Add default archetype with some recommended options 2016-10-17 18:08:39 -04:00
build Add tooling to generate SRI hashes for assets 2017-01-11 10:32:43 +02:00
data Regenerate style.css and SRI hashes 2017-04-16 17:56:29 +03:00
exampleSite exampleSite/config.toml: Document disable_sri option 2017-04-12 21:40:53 +03:00
i18n Adding traditional Chinese translation. 2017-05-19 00:11:13 +08:00
images images/tn.png: New thumbnail without browser 2017-05-28 14:40:49 +03:00
layouts layouts/_default/baseof.html: Allow disabling of SRI 2017-04-12 21:38:10 +03:00
source/scss source/scss/bootstrap.scss: Enable forms 2017-04-16 17:55:52 +03:00
static Regenerate style.css and SRI hashes 2017-04-16 17:56:29 +03:00
.gitignore Revert ".gitignore: Add intermediate output from node-sass" 2016-09-26 10:08:53 +03:00
.travis.yml Add config for Travis CI 2017-03-29 12:38:07 +03:00
LICENSE.txt First commit with initial theme 2016-08-28 16:22:32 +03:00
README.md Add option to control post truncation. 2017-04-04 12:45:11 +03:00
package.json package.json: Bump dependencies to match Bootstrap's 2017-04-26 00:02:37 +03:00
screenshot.png Use 1280x720 screenshot again 2017-02-01 08:45:13 +02:00
theme.toml Change tag from fontawesome to font awesome 2017-04-26 20:31:44 +02:00

README.md

Hugo Bootstrap v4 Blog Build Status

A simple Hugo theme based on the Bootstrap v4 blog example. Opinionated and geared towards blog-style content.

Screenshot

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
  • Allow addition of custom <head> code in site's layouts/partial/head-custom.html (see #17)
  • Configurable display of summaries of content in list templates.

Usage

Clone the repository to your site's themes directory. Refer to exampleSite/config.toml for recommended 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
  • Disable comments on a post by setting comments = false in its frontmatter
  • Disable social sharing icons site wide (or on individual pages/posts) by setting sharingicons = false
  • If your content is stored in git, add enableGitInfo = true to your site config and Hugo will use git history to set a more accurate modification date in page metadata

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 v6 or v7 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
  • Alternatively, tackle one of the existing issues on the issue tracker
  • Fork the repository on GitHub, add features on a "feature" branch like update-bootstrap, and then send a pull request with your changes

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.