Skip to content

Commit

Permalink
added theme code
Browse files Browse the repository at this point in the history
  • Loading branch information
Marco Pas committed Oct 4, 2015
1 parent 8c23b1f commit da249d0
Show file tree
Hide file tree
Showing 46 changed files with 1,219 additions and 0 deletions.
20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2015 Marco Pas

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
117 changes: 117 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
Hugo Bootswatch Theme
==================

Hugo 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/).

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

* pages (used for About/Resume pages)
* posts (used for standard blogposts)
---
* [Installation](#installation)
* [Usage](#usage)
* [Configuration](#configuration)
* [Built-in colour themes](#colour-themes)
* [Questions, ideas, bugs, pull requests?](#questions-ideas-bugs-pull-requests)
* [License](#license)
---
## Installation

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

See the [official Hugo themes documentation](http://gohugo.io/themes/installing) 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
├── about.md // used in the header
└── resume.md // used in the header
```

Just run `hugo --theme=hugo-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/"
[params]
# name of the site author; used in header meta information
author = "<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>"
[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](http://bootswatch.com/) are available. Please checkout Bootswatch to see what theme you want to use.

## Screenshots

### Index Page
![index](http://mpas.github.io/hosted/img/hugo-journal/index.png)

### Post Page
![post](http://mpas.github.io/hosted/img/hugo-journal/post.png)

### List Page
![list](http://mpas.github.io/hosted/img/hugo-journal/list.png)

## Questions, ideas, bugs, pull requests?

All feedback is welcome! Head over to the [issue tracker](https://github.com/zyro/hyde-x/issues).

## License

Open sourced under the [MIT license](https://github.com/marcopas/huugo-bootswatch/blob/master/LICENSE).

## License
Open sourced under the MIT license.
8 changes: 8 additions & 0 deletions archetypes/post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
+++
title = "Post title"
tags = ["tag1", "tag2"]
categories = ["category1","category2"]
date = "2015-01-01"
+++

Content of the file goes here
Binary file added images/index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions layouts/_default/frontpage-post.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{{ if eq .Type "post" }}
<div class="row">
<!-- <div class="col-md-offset-1 col-md-10"> -->
<div class="col-md-offset-1 col-md-10">
<h3><a href="{{.Permalink}}">{{ .Title }}</a></h3>
<span class="label label-primary">{{ .Date.Format "Mon Jan 2, 2006" }}</span> in
{{ range $i, $e :=.Params.categories }}
{{if $i}} , {{end}}
<a href="/categories/{{ . | urlize }}">{{ . }}</a>
{{ end }} using tags
{{ range $i, $e :=.Params.tags }}
{{if $i}} , {{end}}
<a href="/tags/{{ . | urlize }}">{{ . }}</a>
{{ end }}
</small>
</div>
</div>
<div class="row">
<div class="col-md-offset-1 col-md-10">
<br>
{{ .Content }}
</div>
</div>
<div class="row">
<div class="col-md-12">
<hr>
</div>
</div>
{{ end }}
20 changes: 20 additions & 0 deletions layouts/_default/list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{{ partial "header.html" . }}
<div class="row">
<div class="text-center">
<h3>Posts</h3>
</div>
</div>
<div class="row">
<div class="col-md-offset-1 col-md-10">
<ul>
{{ range .Data.Pages }}
{{ .Render "post-title"}}
{{ end }}
</ul>
</div>
</div>
<div class="row">
<hr>
</div>

{{ partial "footer.html" . }}
8 changes: 8 additions & 0 deletions layouts/_default/post-title.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<div class="row">
<div class="col-md-offset-2 col-md-6 col-md-offset-2 col-md-6">
<h4><a href="{{.Permalink}}">{{ .Title }}</a></h4>
</div>
<div class="col-md-4 col-md-4">
<h4>{{ .Date.Format "Mon Jan 2, 2006" }}</h4>
</div>
</div>
25 changes: 25 additions & 0 deletions layouts/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{{ partial "header.html" . }}

<div class="container">
{{ $paginator := .Paginate (where .Data.Pages "Section" "post") }}
{{ range $paginator.Pages }}
{{ .Render "frontpage-post" }}
{{ end }}
</div>
<div class="container">
<div class="row">
<div class="col-md-12">
<div class="text-center">
{{ template "_internal/pagination.html" . }}
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<hr>
</div>
</div>
</div>
{{ partial "footer.html" . }}


23 changes: 23 additions & 0 deletions layouts/page/single.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{{ partial "header.html" . }}

<div class="container">
<div class="row">
<div class="col-md-offset-1 col-md-10">
<h3>{{ .Title }}</h3>
<span class="label label-primary">{{ .Date.Format "Mon Jan 2, 2006" }}</span>
</div>
</div>
<div class="row">
<div class="col-md-offset-1 col-md-10">
<br>
{{ .Content }}
</div>
</div>
<div class="row">
<div class="col-md-12">
<hr>
</div>
</div>
</div>

{{ partial "footer.html" . }}
37 changes: 37 additions & 0 deletions layouts/partials/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<div class="container">
<div class="row col-md-12">
<footer>
<div class="pull-left">
<p>
&copy; 2014 {{ .Site.Params.author }} ~ Powered By <a href="http://hugo.spf13.com">Hugo</a> - version: {{ .Hugo.Version }} ~ Copyright © 2015 <a href="{{ .Site.BaseURL }}/license">License</a>
</p>
</div>

<!-- social icons -->
<div class="pull-right">
{{ if isset .Site.Params "facebook" }}
<a href="{{ .Site.Params.facebook }}" target="_blank">
<i class="fa fa-facebook-square fa-2x"></i></a>
{{ end }}
{{ if isset .Site.Params "twitter" }}
<a href="{{ .Site.Params.twitter }}" target="_blank">
<i class="fa fa-twitter-square fa-2x"></i></a>
{{ end }}
{{ if isset .Site.Params "github" }}
<a href="{{ .Site.Params.github }}" target="_blank">
<i class="fa fa-github-square fa-2x"></i></a>
{{ end }}
{{ if isset .Site.Params "delicious" }}
<a href="{{ .Site.Params.delicious }}" target="_blank">
<i class="fa fa-delicious fa-2x"></i></a>
{{ end }}
<a href="{{ .RSSlink }}" target="_blank">
<i class="fa fa-rss-square fa-2x"></i></a>
</div>
</footer>
</div>
</div>

<!-- container section end -->
</body>
</html>
37 changes: 37 additions & 0 deletions layouts/partials/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!DOCTYPE html>
<html class="no-js" lang="en-US" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en-us">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<meta name="description" content="{{ .Title }}">
<meta name="author" content="{{ .Site.Params.author }}">

<meta name="keyword" content="">
<link rel="shortcut icon" href="/img/favicon.ico">

<title>{{ if eq .URL "/" }}{{ .Site.Title }}{{ else if eq .URL "/post/" }}All Entries &middot; {{ .Site.Title }}{{ else if in .URL "/tags/" }}Tags | {{ .Site.Title }}{{ else }}{{ .Title }}{{ end }}</title>

<!-- selection of themed bootstrap css to load-->
{{ if isset .Site.Params "theme" }}
<link rel="stylesheet" href="{{ .Site.BaseURL }}/css/theme/{{ .Site.Params.theme.name }}.css">
{{ else}}
<link rel="stylesheet" href="{{ .Site.BaseURL }}/css/theme/default.css">
{{ end }}

<link rel="stylesheet" href="{{ .Site.BaseURL }}/css/font-awesome.min.css">

<!-- include custom css -->
<link rel="stylesheet" href="{{ .Site.BaseURL }}/css/style.css">


<!-- javascript -->
<script src="{{ .Site.BaseURL }}/js/jquery.min-2.1.4.js"></script>
<script src="{{ .Site.BaseURL }}/js/bootstrap.min-3.3.5.js"></script>

<!-- rss -->
<link href="{{ .RSSlink }}" rel="alternate" type="application/rss+xml" title="{{ .Site.Title }}" />
</head>
<body lang="en">
<!-- navbar -->
{{ partial "navbar" . }}
17 changes: 17 additions & 0 deletions layouts/partials/navbar.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<div class="container">
<div class="row">
<div class="navbar navbar-default {{ if .Site.Params.theme.inverse }}navbar-inverse{{ end }}" role="navigation">
<div class="navbar-header">
<a class="navbar-brand" href="{{.Site.BaseURL}}">{{ .Site.Title }}</a>
</div>
<div class="navbar-collapse collapse navbar-responsive-collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="{{ .Site.BaseURL }}">Home</a></li>
<li><a href="{{ .Site.BaseURL }}/page/about/">About</a></li>
<li><a href="{{ .Site.BaseURL }}/page/resume/">Resume</a></li>
<li><a href="{{ .Site.BaseURL }}/post/">Blog</a></li>
</ul>
</div>
</div>
</div>
</div>
32 changes: 32 additions & 0 deletions layouts/post/single.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{{ partial "header.html" . }}

<div class="container">
<div class="row">
<div class="col-md-offset-1 col-md-10">
<h3>{{ .Title }}</h3>
<span class="label label-primary">{{ .Date.Format "Mon Jan 2, 2006" }}</span> in
{{ range $i, $e :=.Params.categories }}
{{if $i}} , {{end}}
<a href="/categories/{{ . | urlize }}">{{ . }}</a>
{{ end }} using tags
{{ range $i, $e :=.Params.tags }}
{{if $i}} , {{end}}
<a href="/tags/{{ . | urlize }}">{{ . }}</a>
{{ end }}
</small>
</div>
</div>
<div class="row">
<div class="col-md-offset-1 col-md-10">
<br>
{{ .Content }}
</div>
</div>
<div class="row">
<div class="col-md-12">
<hr>
</div>
</div>
</div>

{{ partial "footer.html" . }}
4 changes: 4 additions & 0 deletions static/css/font-awesome.min.css

Large diffs are not rendered by default.

Empty file added static/css/style.css
Empty file.
Loading

0 comments on commit da249d0

Please sign in to comment.