/hugo-multi-bootswatch

Hugo Multi BootSwatch Theme is a single column theme for [hugo](http://hugo.spf13.com/) based on [Twitter Bootstrap](http://getbootstrap.com/) and a css styling from [Bootswatch](http://bootswatch.com/).

Primary LanguageHTMLMIT LicenseMIT

Hugo Multi Bootswatch Theme

Hugo Multi BootSwatch Theme is a single column theme for hugo based on Twitter Bootstrap and a css styling from Bootswatch.

It is a simple template containing a nice header menu bar and content area. Default the theme support 2 types of content.

  • posts (used for standard blogposts and optional be placed in the menu!)
  • links (used for "linklogs", small blocks of text with link to external site)

You can add posts to the main menu see Adding posts to main menu. For understanding, what is "linklog" see Linklog usage



Contributors


Installation

$ cd your_site_repo/
$ mkdir themes
$ cd themes
$ git clone https://github.com/mpas/hugo-multi-bootswatch.git

See the official Hugo themes documentation for more info.

Usage

This theme expects a relatively standard Hugo blog/personal site layout:

.
└── content
    ├── post
    |   ├── post1.md
    |   └── post2.md
    └── page
        ├── license.md      // this is used in the footer link

Just run hugo --theme=hugo-multi-bootswatch to generate your site!

Configuration

An example of what your site's config.toml could look like. All theme-specific parameters are under [params] and standard Hugo parameters are used where possible.

baseurl     = "http://example.com"  # the baseurl for your website
title       = "Your site title"     # blog title
paginate    = 10                    # the number of posts on a page

[permalinks]
    # Optional. Change the permalink format for the 'post' content type.
    # The format shown here is the same one Jekyll/Octopress uses by default.
    post = "/blog/:year/:month/:day/:title/"

[author]
    # Optional. Used in RSS feed meta information.
    name = "your name"
    email = "example <at> example <dot> com"

[params]
    # language code for your website
    languagecode = "en-US"

    # name of the site author; used in header meta information
    author = "<authorname>"

    # copyright text; used in footer
    copyright = "2015 ~ <authorname>"

    # social links, used in footer, these must be full URLs.
    twitter     = "https://twitter.com/<username>"
    github      = "https://github.com/<username>"
    facebook    = "https://www.facebook.com/<username>"
    delicious   = "https://delicious.com/<username>"
    linkedin    = "https://www.linkedin.com/in/<username>"
    flickr      = "https://www.flickr.com/photos/<username>"

    # show default summaries on the frontpage or not
    use_summaries = false

# naming of the elements in your blog/site
[params.strings]
    # name of the link to the homepage
    home_navbar_link = "Home"

    # name of the link to the blog page
    blog_navbar_link = "Blog"

    # name of the header used in the post list page
    posts_list_header = "Posts"

    # used date format
    date_format = '02.01.2006'

[params.theme]
    inverse = false     # indicating if the theme should use inversed colors
    name = "cerulean"   # name of the theme to use

    # list of possible theme names that can be used
    # name = "cerulean"
    # name = "cosmo"
    # name = "cyborg"
    # name = "default"
    # name = "flatly"
    # name = "journal"
    # name = "lumen"
    # name = "paper"
    # name = "readable"
    # name = "sandstone"
    # name = "simplex"
    # name = "slate"
    # name = "spacelabs"
    # name = "superhero"
    # name = "united"
    # name = "yeti"

Colour themes

All the available color themes from Bootswatch are available. Please checkout Bootswatch to see what theme you want to use.

Adding post to main menu

If you want to add a post to the main menu then include the following to the frontmatter:

+++
...
menu = "main"
+++

The menu = main will add the post to the menu. These posts will not be included in the listing of normal posts or in the frontpage!!

Linklog usage

Some people using their blogs as place for sharing links and storing their own opinion on them. In this theme you have separate content type named "link" for this. Every link produces small block of text on your front page (and in RSS feed too) with your comment on it.

For creating new link in your linklog, invoke

hugo new link/example.md

It will create template with frontmatter like this:

+++
draft = true
title = "Title of the external link"
author = "Author of the external content"
ref = "http://example.com/"
type = "link"
+++

Content of your comment on external link goes here.

where title is a title of your comment on link, author is the author of original content you refer to, ref is a link to the content, and type indicates that this is linklog content.

Screenshots

Index Page

index

Post Page

post

List Page

list

Themed Screenshots

Cerulean

normal: index inversed: index

Cosmo

normal: index inversed: index

Cyborg

normal: index inversed: index

Default

normal: index inversed: index

Flatly

normal: index inversed: index

Journal

normal: index inversed: index

Lumen

normal: index inversed: index

Paper

normal: index inversed: index

Readable

normal: index inversed: index

Sandstone

normal: index inversed: index

Simplex

normal: index inversed: index

Slate

normal: index inversed: index

Spacelab

normal: index inversed: index

Superhero

normal: index inversed: index

United

normal: index index

Yeti

normal: index index

Questions, ideas, bugs, pull requests?

All feedback is welcome! Head over to the issue tracker.

License

Open sourced under the MIT license.