hugo-theme-bootstrap4-blog/README.md

# Hugo Bootstrap v4 Blog [![Build Status](https://travis-ci.org/alanorth/hugo-theme-bootstrap4-blog.svg?branch=master)](https://travis-ci.org/alanorth/hugo-theme-bootstrap4-blog)
A simple [Hugo](https://gohugo.io) theme based on the [Bootstrap v4 blog example](https://getbootstrap.com/docs/4.0/examples/blog). Opinionated and geared towards blog-style content.

![Screenshot](https://raw.githubusercontent.com/alanorth/hugo-theme-bootstrap4-blog/master/screenshot.png "Screenshot")

See [picturingjordan.com](https://picturingjordan.com) for an example of this theme in use.

## Features

- Responsive design
- Uses Bootstrap v4's [native system font stack](https://getbootstrap.com/docs/4.0/content/reboot/#native-font-stack) to load quickly and look good on all platforms
- Basic [OpenGraph](http://ogp.me) and [Twitter Card](https://dev.twitter.com/cards/types) metadata support
- robots.txt linking to XML sitemap (disabled by default, see [Hugo docs](https://gohugo.io/extras/robots-txt/))
- Basic support for [multi-lingual content](https://gohugo.io/content-management/multilingual/) (added in Hugo 0.17)
- Supports Google, Bing, and Yandex site verification via meta tags
- Supports Google Analytics (async version), see [Hugo docs](https://gohugo.io/extras/analytics/)
- Supports Disqus comments, see [Hugo docs](https://gohugo.io/extras/comments/)
- Can show a message about cookie usage to the user, see [`exampleSite/config.toml`](https://github.com/alanorth/hugo-theme-bootstrap4-blog/blob/master/exampleSite/config.toml)
- Allow addition of custom `<head>` code in site's `layouts/partial/head-custom.html` (see [#17](https://github.com/alanorth/hugo-theme-bootstrap4-blog/pull/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`](https://github.com/alanorth/hugo-theme-bootstrap4-blog/blob/master/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](https://github.com/alanorth/picturingjordan.com) to get more ideas.

## Building (For Developers)
This theme uses the [Bootstrap](https://getbootstrap.com/) 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:

```console
$ npm install
$ npm run build
```

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

- [Open an issue](https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues/new) on GitHub if you have problems or feature requests
- Alternatively, tackle one of the [existing issues](https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues) on the issue tracker
- Fork [the repository](https://github.com/alanorth/hugo-theme-bootstrap4-blog) on GitHub, add features on a "feature" branch like `update-bootstrap`, and then send a [pull request](https://github.com/alanorth/hugo-theme-bootstrap4-blog/compare) with your changes

## License
This repository contains the code of [Bootstrap](http://getbootstrap.com), which is licensed under the [MIT license](https://tldrlegal.com/license/mit-license), and [Font Awesome](http://fontawesome.io/), which uses [various licenses](http://fontawesome.io/license/).

Otherwise, the contents are [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt).
README.md: Add icon for Travis CI build status 2017-03-29 11:48:00 +02:00			`# Hugo Bootstrap v4 Blog [![Build Status](https://travis-ci.org/alanorth/hugo-theme-bootstrap4-blog.svg?branch=master)](https://travis-ci.org/alanorth/hugo-theme-bootstrap4-blog)`
README.md: Update links to Bootstrap 4.0 docs 2017-08-13 10:47:05 +02:00			`A simple [Hugo](https://gohugo.io) theme based on the [Bootstrap v4 blog example](https://getbootstrap.com/docs/4.0/examples/blog). Opinionated and geared towards blog-style content.`
First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00
README.md: Replace screenshot with less blurry one 2017-01-31 19:04:06 +01:00			`![Screenshot](https://raw.githubusercontent.com/alanorth/hugo-theme-bootstrap4-blog/master/screenshot.png "Screenshot")`
Add screenshot to README.md 2016-08-28 18:31:31 +02:00
README.md: Minor style/flow adjustments 2016-10-18 00:00:08 +02:00			`See [picturingjordan.com](https://picturingjordan.com) for an example of this theme in use.`
README.md: Add link to my blog for an example of this theme in use 2016-09-25 08:02:13 +02:00
README.md: Start a "Features" section 2016-09-18 13:04:04 +02:00			`## Features`

README.md: Update features and TODOs Displaying tags/categories and paginating posts aren't really features! 2016-10-19 05:15:19 +02:00			`- Responsive design`
README.md: Grammar 2017-08-13 10:47:33 +02:00			`- Uses Bootstrap v4's [native system font stack](https://getbootstrap.com/docs/4.0/content/reboot/#native-font-stack) to load quickly and look good on all platforms`
README.md: Start a "Features" section 2016-09-18 13:04:04 +02:00			`- Basic [OpenGraph](http://ogp.me) and [Twitter Card](https://dev.twitter.com/cards/types) metadata support`
README.md: Add note about robots.txt 2016-09-21 21:47:02 +02:00			`- robots.txt linking to XML sitemap (disabled by default, see [Hugo docs](https://gohugo.io/extras/robots-txt/))`
README.md: Update link to multi-lingual content docs Thanks to @jodumont for reporting this on GitHub. See: https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues/77 2017-11-22 10:30:12 +01:00			`- Basic support for [multi-lingual content](https://gohugo.io/content-management/multilingual/) (added in Hugo 0.17)`
README.md: Update features Use consistent style 2016-10-26 01:20:00 +02:00			`- Supports Google, Bing, and Yandex site verification via meta tags`
			`- Supports Google Analytics (async version), see [Hugo docs](https://gohugo.io/extras/analytics/)`
README.md: Add notes about Disqus comments 2016-11-02 14:25:03 +01:00			`- Supports Disqus comments, see [Hugo docs](https://gohugo.io/extras/comments/)`
README.md: Add cookie consent to features 2016-11-13 13:17:53 +01:00			- Can show a message about cookie usage to the user, see [`exampleSite/config.toml`](https://github.com/alanorth/hugo-theme-bootstrap4-blog/blob/master/exampleSite/config.toml)
README.md: Add note about custom head code 2016-11-27 12:31:57 +01:00			- Allow addition of custom `<head>` code in site's `layouts/partial/head-custom.html` (see [#17](https://github.com/alanorth/hugo-theme-bootstrap4-blog/pull/17))
Add option to control post truncation. 2017-04-03 05:54:42 +02:00			`- Configurable display of summaries of content in list templates.`
README.md: Start a "Features" section 2016-09-18 13:04:04 +02:00
First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00			`## Usage`
README.md: Change wording about config.toml to "recommended" The theme really needs some config options in order to look decent, so I will change the wording here from "optional" to "recommended". Hopefully some users actually read this rather sparse readme, as there have been several GitHub issues opened due to misconfigured sites. 2017-01-08 23:32:37 +01:00			Clone the repository to your site's `themes` directory. Refer to [`exampleSite/config.toml`](https://github.com/alanorth/hugo-theme-bootstrap4-blog/blob/master/exampleSite/config.toml) for recommended configuration values.
First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00
README.md: Add content suggestions 2016-10-26 01:38:41 +02:00			`## 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`
README.md: Fix syntax error 2016-10-26 16:15:22 +02:00			- 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"]`
README.md: Add content suggestions 2016-10-26 01:38:41 +02:00			- Use the `<!--more-->` tag in posts to control how much of a post is shown on summary pages
README.md: Add note about disabling comments on a post 2016-12-24 16:21:26 +01:00			- Disable comments on a post by setting `comments = false` in its frontmatter
README.md: Add note about disabling sharing icons 2017-01-22 12:53:18 +01:00			- Disable social sharing icons site wide (or on individual pages/posts) by setting `sharingicons = false`
README.md: Add note about enableGitInfo 2017-01-23 14:10:53 +01:00			- 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
README.md: Add content suggestions 2016-10-26 01:38:41 +02:00
			`See the source code and structure of [picturingjordan.com](https://github.com/alanorth/picturingjordan.com) to get more ideas.`

README.md: Remove npm packages badge The image seems to be broken any time I look at it on the GitHub repository page despite being fine if you click it and view the original on david-dm.org. 2017-01-24 11:39:59 +01:00			`## Building (For Developers)`
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 16:21:34 +02:00			`This theme uses the [Bootstrap](https://getbootstrap.com/) 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:`
First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00
README.md: Add GitHub flavored Markdown to code block 2017-01-09 12:25:54 +01:00			```console
First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00			`$ npm install`
			`$ npm run build`
			```

README.md: Add notes about contributing 2016-11-16 08:38:11 +01:00			`## Contributing`
			`There are several ways to help with the development of the theme:`

			`- [Open an issue](https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues/new) on GitHub if you have problems or feature requests`
README.md: Remove TODOs Add individual GitHub issues for them and suggest that people who are interested go tackle one of them and contribute fixes there. See: https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues 2016-11-27 12:27:57 +01:00			`- Alternatively, tackle one of the [existing issues](https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues) on the issue tracker`
README.md: Add notes about contributing 2016-11-16 08:38:11 +01:00			- Fork [the repository](https://github.com/alanorth/hugo-theme-bootstrap4-blog) on GitHub, add features on a "feature" branch like `update-bootstrap`, and then send a [pull request](https://github.com/alanorth/hugo-theme-bootstrap4-blog/compare) with your changes

First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00			`## License`
README.md: Update license section for Font Awesome 2016-09-25 08:07:12 +02:00			`This repository contains the code of [Bootstrap](http://getbootstrap.com), which is licensed under the [MIT license](https://tldrlegal.com/license/mit-license), and [Font Awesome](http://fontawesome.io/), which uses [various licenses](http://fontawesome.io/license/).`
First commit with initial theme Some file are empty (created by `hugo new theme`), but I've left them for reference later. 2016-08-28 15:21:39 +02:00
README.md: Adjust license text 2016-08-28 15:27:54 +02:00			`Otherwise, the contents are [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt).`