hugo-theme-bootstrap4-blog/README.md

# Hugo Bootstrap v4 Blog
A simple [Hugo](https://gohugo.io) theme based on the [Bootstrap v4 blog example](http://v4-alpha.getbootstrap.com/examples/blog). Geared towards simple blogging. Still a work in progress.

![Screenshot](/screenshot@2x.png?raw=true "Screenshot")

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

## Features

- Uses Bootstrap v4's [native system fonts](http://v4-alpha.getbootstrap.com/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/))
- Displays categories and tags from front matter
- Basic support for [multi-lingual content](https://github.com/spf13/hugo/blob/master/docs/content/content/multilingual.md) (added in Hugo 0.17)
- Configurable [pagination](https://gohugo.io/extras/pagination/) for posts, categories, and tags pages

## 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](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 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 configurable license notice for footer
- add favicon
- add author page (for when you click author name in a post/summary) [#2](https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues/2)
- add images to sitemap? https://gohugo.io/templates/sitemap/
- add Bing and Yandex verification support
- add support for Disqus (I don't use it!)
- add support for Google Analytics (I don't use it!)
- test multilang stuff like menus, probably need more absURL/relURL fixes

## 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).
Update theme name 2016-09-18 11:25:19 +02:00			`# Hugo Bootstrap v4 Blog`
README.md: Update description 2016-09-18 16:09:53 +02:00			`A simple [Hugo](https://gohugo.io) theme based on the [Bootstrap v4 blog example](http://v4-alpha.getbootstrap.com/examples/blog). Geared towards simple blogging. Still a work in progress.`
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
Add screenshot to README.md 2016-08-28 18:31:31 +02:00			`![Screenshot](/screenshot@2x.png?raw=true "Screenshot")`

README.md: Add link to my blog for an example of this theme in use 2016-09-25 08:02:13 +02:00			`See [my blog](https://picturingjordan.com) for an example of this theme in use.`

README.md: Start a "Features" section 2016-09-18 13:04:04 +02:00			`## Features`

README.md: Update features with native fonts 2016-09-25 08:17:54 +02:00			`- Uses Bootstrap v4's [native system fonts](http://v4-alpha.getbootstrap.com/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 TODOs and features for category/tag support 2016-09-26 07:40:06 +02:00			`- Displays categories and tags from front matter`
README.md: Add note about multi-lingual content support 2016-10-03 17:01:25 +02:00			`- Basic support for [multi-lingual content](https://github.com/spf13/hugo/blob/master/docs/content/content/multilingual.md) (added in Hugo 0.17)`
README.md: Add link to Hugo docs for pagination 2016-10-05 16:24:00 +02:00			`- Configurable [pagination](https://gohugo.io/extras/pagination/) for posts, categories, and tags pages`
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: Add note about example config.toml 2016-09-14 15:03:58 +02:00			Clone the repository to your site's `themes` directory. Refer to `exampleSite/config.toml` for optional 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
			`## Building (For Developers)`
README.md: Remove jQuery references I'm not using it at the moment. I can re-add it if I need any of Bootstrap's features that are using jQuery. 2016-08-29 16:18:37 +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 v4 or 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
			```
			`$ npm install`
			`$ npm run build`
			```

README.md: Add some TODOs 2016-09-13 15:55:55 +02:00			`## TODO`

			`- add optional social links to sidebar`
			`- add configurable license notice for footer`
README.md: Update TODO 2016-09-13 15:59:21 +02:00			`- add favicon`
README.md: Link another TODO to GitHub issue 2016-09-25 06:48:29 +02:00			`- add author page (for when you click author name in a post/summary) [#2](https://github.com/alanorth/hugo-theme-bootstrap4-blog/issues/2)`
README.md: Update TODOs 2016-09-14 13:39:41 +02:00			`- add images to sitemap? https://gohugo.io/templates/sitemap/`
README.md: Add more TODOs 2016-09-26 16:37:59 +02:00			`- add Bing and Yandex verification support`
			`- add support for Disqus (I don't use it!)`
			`- add support for Google Analytics (I don't use it!)`
README.md: Update TODOs 2016-10-03 21:30:08 +02:00			`- test multilang stuff like menus, probably need more absURL/relURL fixes`
README.md: Add some TODOs 2016-09-13 15:55:55 +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			`## 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).`