A vanilla Bootstrap theme for Hugo
Clone or download

README.md

Vanilla Bootstrap

A vanilla Bootstrap theme for Hugo.

Table of Contents

Demos

Env URL
Dev demo, immediate updates https://vanilla-bootstrap-hugo-theme.netlify.com/
Hugo Themes demo, weekly-ish updates https://themes.gohugo.io//theme/vanilla-bootstrap-hugo-theme/

Minimum Hugo Version

This theme requires Hugo version 0.48 or higher. Take a look at the Hugo releases and download the binary for your OS.

Installation

From the root of your site:

git submodule add https://github.com/zwbetz-gh/vanilla-bootstrap-hugo-theme.git themes/vanilla-bootstrap-hugo-theme

Updating

From the root of your site:

git submodule update --remote --merge

Run Example Site

From the root of themes/vanilla-bootstrap-hugo-theme/exampleSite:

hugo server --themesDir ../..

Configuration

Copy the config.toml or config.yaml from the exampleSite, then edit as desired.

Shortcodes

bootstrap-blockquote

Uses Bootstrap blockquotes to format your blockquotes nicely. Pass the quote inside the shortcode. The author argument is optional.

Here's an actual usage, and here's an example usage:

{{% bootstrap-blockquote author="Carl Jung" %}}
Knowing your own darkness is the best method for dealing with the darknesses of other people.
{{% /bootstrap-blockquote %}}

bootstrap-table

Uses Bootstrap tables to format your tables nicely. Pass the markdown table inside the shortcode, then pass the classes as an argument.

Here's an actual usage, and here's an example usage:

{{< bootstrap-table "table table-dark table-striped table-bordered" >}}
| Animal  | Sounds |
|---------|--------|
| Cat     | Meow   |
| Dog     | Woof   |
| Cricket | Chirp  |
{{< /bootstrap-table >}}

bootstrap-card

Uses Bootstrap cards and Hugo image processing to display your page bundle images nicely. Only the img, command, and options arguments are required.

Here's an actual usage, and here's an example usage:

{{< bootstrap-card 
img="sun.jpg" 
command="Resize" 
options="700x" 
title="The Sun"
text="The Sun is the star at the center of the Solar System."
alt="sun" 
class="mb-3" 
style="" >}}

Getting Help

If you run into an issue that isn't answered by this documentation or the exampleSite, then head over to the Hugo discussion forum. The folks there are helpful and friendly. Before asking your question, be sure to read the requesting help guidelines. Feel free to tag me in your question, my username there is @zwbetz.

Credits

In addition to Bootstrap and Hugo, thank you to: