alanorth/hugo-theme-bootstrap4-blog
1
0
Fork 0
mirror of https://github.com/alanorth/hugo-theme-bootstrap4-blog.git synced 2024-11-17 17:57:04 +01:00
Code Releases Activity
84e9cd1559
hugo-theme-bootstrap4-blog/README.md
Alan Orth 3c2b9d5bc0
README.md: Adjust NodeJS version comment 
I've been using NodeJS v4, v6, v7, and v8 to build this and they all
work fine, so I'll just say >= v6 because it's the latest long-term
support release as of right now.
2017-09-29 17:21:34 +03:00

4.4 KiB
Raw Blame History

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