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
A blogging-centric Bootstrap v4 theme for the Hugo static site generator.
218 Commits 1 Branch 21 Tags 4.6 MiB
HTML 86%
SCSS 11.5%
JavaScript 2.5%
1341bbd436
Go to file
Alan Orth 1341bbd436
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 13:27:57 +02:00
archetypes Add default archetype with some recommended options 2016-10-17 18:08:39 -04:00
exampleSite Add Vim Modeline Comments to Files (#18) 2016-11-24 14:33:56 +02:00
i18n Make "→" in "Read more" part of the i18n strings 2016-11-20 12:14:46 +02:00
images Add screenshot and thumbnail for Hugo themes directory 2016-10-17 22:18:39 -04:00
layouts layouts: retab after addition of modelines 2016-11-24 14:39:39 +02:00
source/scss source/scss: Only import parts of font-awesome that we actually need 2016-11-16 12:00:21 +02:00
static static/css/style.css: Regenerate 2016-11-16 12:03:20 +02:00
.gitignore Revert ".gitignore: Add intermediate output from node-sass" 2016-09-26 10:08:53 +03:00
LICENSE.txt First commit with initial theme 2016-08-28 16:22:32 +03:00
package.json package.json: Add run script for cookieconsent 2016-11-13 13:42:22 +02:00
README.md README.md: Remove TODOs 2016-11-27 13:27:57 +02:00
screenshot@2x.png Update screenshot 2016-09-26 09:06:21 +03:00
theme.toml Add Vim Modeline Comments to Files (#18) 2016-11-24 14:33:56 +02:00

README.md

Hugo Bootstrap v4 Blog

A simple Hugo theme based on the Bootstrap v4 blog example.

Screenshot

See picturingjordan.com for an example of this theme in use.

Features

Usage

Clone the repository to your site's themes directory. Refer to exampleSite/config.toml for optional 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

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 v4 or 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.