mirror of
https://github.com/alanorth/hugo-theme-bootstrap4-blog.git
synced 2024-06-29 09:33:45 +02:00
Alan Orth
fa8b65dda6
Add link to multilingual docs and remove TODO for Twitter username since I'm using Hugo's own logic for Twitter cards now.
43 lines
2.6 KiB
Markdown
43 lines
2.6 KiB
Markdown
# 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.
|
|
|
|
|
|
|
|
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
|
|
- Support Google, Bing, and Yandex site verification via meta tags
|
|
- Support Google Analytics (async version), see [Hugo docs](https://gohugo.io/extras/analytics/)
|
|
|
|
## 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 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 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 support for Disqus (I don't use it!)
|
|
- test multilingual stuff like menus, probably need more absURL/relURL fixes (see [Hugo docs](https://github.com/spf13/hugo/blob/master/docs/content/content/multilingual.md))
|
|
|
|
## 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).
|