Hugo theme based on
the Bootstrap starter
template
example with Bootstrap examples in the exampleSite.
This theme implements https://getbootstrap.com/docs/4.0/examples/ in Hugo, it focus on offering a quick way to have Bootstrap in your Hugo site with:
- a clean setup and
- the ability to customize Bootstrap variables.
- Shortcodes Bootstrap components
https://marcanuy.github.io/hugo-bootstrap-examples-theme/.
Table of Contents
Customization ca be done in two steps:
- override variables:
Every Sass variable in Bootstrap 4 includes the !default flag allowing you to override the variable’s default value in your own Sass without modifying Bootstrap’s source code. Copy and paste variables as needed, modify their values, and remove the !default flag. If a variable has already been assigned, then it won’t be re-assigned by the default values in Bootstrap.
So in src/style.scss we can customize any Bootstrap
variable
and then import the complete Bootstrap styles which will incorporate
our custom design:
// Your variable overrides
$body-bg: #000;
$body-color: #111;
// Bootstrap and its default variables
@import "../node_modules/bootstrap/scss/bootstrap";
- Regenerate stylesheet:
The above file will be processed with node-sass and generate
static/css/style.css after executing the make build recipe.
More on Bootstrap 4 customization: https://getbootstrap.com/docs/4.0/getting-started/theming/#variable-defaults.
Bootstrap is a package.json dependency, it can easily be updated
with npm update or yarn update.
Run the following commands inside your Hugo site folder:
$ git clone https://github.com/marcanuy/hugo-bootstrap-starter-template.git themes/hugo-boostrap-starter-template
Alternatively use git submodules in order to have a way to easily update the theme from the source in case you have your site in git as well. For this run the following commands inside your Hugo site folder:
$ git submodule add https://github.com/marcanuy/hugo-bootstrap-starter-template.git themes/hugo-boostrap-starter-template
If you checkout your site from a repository which has this added as a submodule (e.g. if you are using CI to deploy), execute following commands or put them into a initgit.sh file in your repository which can be executed by your CI:
$ git submodule init
$ git submodule update
In order to update all the existing submodules from their upstreams, you can either go into each submodule root folder and do the normal git pull or execute following command:
$ git submodule foreach git pull
Run make install to install theme dependencies. That will run yarn install (or npm install).
Run make build to generate CSS styles and copy the necessary
Javascript libraries.
- Bootstrap docs
- Hugo docs
- Installation instruction taken from Hugo dimension theme