Giter Club home page Giter Club logo

minimal-bootstrap-hugo-theme's Introduction

Minimal Bootstrap Hugo Theme

Netlify Status

A minimal hugo theme made with bootstrap that focuses on content readability.

Table of contents

Demo

https://minimal-bootstrap-hugo-theme.netlify.com/

Minimum Hugo version

Hugo version 0.60.1 or higher is required. View 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/minimal-bootstrap-hugo-theme.git themes/minimal-bootstrap-hugo-theme

Updating

From the root of your site:

git submodule update --remote --merge

Run example site

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

hugo server --themesDir ../..

Configuration

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

Favicons

Upload your image to RealFaviconGenerator then copy-paste the generated favicon files under static.

Override

Homepage example

As an example, let's say you didn't like the default homepage, and wanted to design one of your own. To do this, you would:

  1. Copy file YOUR_SITE/themes/minimal-bootstrap-hugo-theme/layouts/index.html
  2. Paste that file to YOUR_SITE/layouts/index.html
  3. Edit index.html as desired

Configure cookie consent

You can change the position, layout, color palette, "Learn more" link, compliance type, and custom text of the cookie consent popup. To do this, you would:

  1. Copy file YOUR_SITE/themes/minimal-bootstrap-hugo-theme/layouts/partials/cookie-consent.html
  2. Paste that file to YOUR_SITE/layouts/partials/cookie-consent.html
  3. Complete the cookie consent wizard
  4. Paste the generated code from the wizard into cookie-consent.html

Syntax highlighting

Hugo has built-in syntax highlighting, provided by Chroma. It is currently enabled in the config.toml file from the exampleSite.

Checkout the Chroma style gallery and choose the style you like.

Shortcodes

blockquote

This will format your blockquotes nicely. To use it, put the quote within the shortcode. The author argument is optional.

{{< blockquote author="Laura Ingalls" >}}
I am beginning to learn that it is the sweet, **simple** things of life which are the real ones after all.  
{{< /blockquote >}}

imgAbs

This will insert an image into your content by absolute path. To use it, pass the pathURL of your image.

These arguments are optional: alt, class, style.

{{< imgAbs 
pathURL="img/some-img.png" 
alt="Some description" 
class="some-class" 
style="some-style" >}}

imgRel

This will insert an image into your content by relative path. To use it, pass the pathURL of your image.

These arguments are optional: alt, class, style.

{{< imgRel 
pathURL="img/some-img.png" 
alt="Some description" 
class="some-class" 
style="some-style" >}}

imgProc

This will process an image from a page bundle, then provide a link to the original image. To use it, pass the image name, command, and command options.

The command argument will be one of: Resize, Fit, Fill. For a deeper dive see the hugo docs for image processing.

These arguments are optional: alt, class, style.

The below example resizes an image to 800px width, while keeping the aspect ratio.

{{< imgProc 
img="some-img.png" 
command="Resize" 
options="800x" 
alt="Some description" 
class="some-class" 
style="some-style" >}}

mastodon

This will embed a toot in an iframe.

These arguments are optional: width, height.

{{% mastodon
status="https://mastodon.social/@kevingimbel/100700713283716694"
width="1000" height="500" %}}

fileRel

This will insert a link to a file by relative path into your content. To use it, pass the pathURL of your file.

The arguments class and style are optional.

{{< fileRel 
  pathURL="files/file.pdf"
  name="filename" 
  class="someclass" 
  style="somestyle" >}},

Getting help

If you run into an issue that isn't answered by this documentation or the exampleSite, then visit the Hugo forum. The folks there are helpful and friendly. Before asking your question, be sure to read the requesting help guidelines.

minimal-bootstrap-hugo-theme's People

Contributors

zwbetz-gh avatar alephnull avatar gimmy avatar ristobin avatar dz-s avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.