hugo-theme-bootstrap4-blog/README.md

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

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

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

- tags + categories!
- add metadata for open graph
- 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)
- add images to sitemap? https://gohugo.io/templates/sitemap/

## License
This repository contains the code of [Bootstrap](http://getbootstrap.com), which is licensed under the [MIT license](https://tldrlegal.com/license/mit-license).

Otherwise, the contents are [GPLv3](https://www.gnu.org/licenses/gpl-3.0.txt).
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			`# Hugo Bootstrap v4`
README.md: Add note that this is still a work in progress 2016-08-28 18:35:45 +02:00			`A simple [Hugo](https://gohugo.io) theme based on the [Bootstrap v4 blog example](http://v4-alpha.getbootstrap.com/examples/blog). 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")`

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`

			`- tags + categories!`
			`- add metadata for open graph`
			`- 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: Update TODOs 2016-09-14 11:31:37 +02:00			`- add author page (for when you click author name in a post/summary)`
README.md: Update TODOs 2016-09-14 13:39:41 +02:00			`- add images to sitemap? https://gohugo.io/templates/sitemap/`
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: 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 repository contains the code of [Bootstrap](http://getbootstrap.com), which is licensed under the [MIT license](https://tldrlegal.com/license/mit-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).`